bvreede / my-python-project Goto Github PK
View Code? Open in Web Editor NEWLicense: Apache License 2.0
License: Apache License 2.0
Your repository has a workflow which lints your code after every push and when creating a pull request.
Linter workflow may fail if description
or keywords
field in setup.cfg is empty. Please update these fields. To validate your changes run:
prospector
Enabling githook will automatically lint your code in every commit. You can enable it by running the command below.
git config --local core.hooksPath .githooks
It is likely that your CITATION.cff
currently doesn't pass validation. The error messages you get from the cffconvert
GitHub Action are unfortunately a bit cryptic, but doing the following helps:
given-name
and family-name
keys need updating. If your family name has a name particle like von
or van
or de
, use the name-particle
key; if your name has a suffix like Sr
or IV
, use name-suffix
. For details, refer to the schema description: https://github.com/citation-file-format/citation-file-formatorcid
key. If you do not have an orcid yet, you can get one here https://orcid.org/.date-released
using the YYYY-MM-DD format.doi
key with the conceptDOI for your repository (see https://help.zenodo.org for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string 10.0000/FIXME
to pass validation.keywords
array accurately describes your project.Once you do all the steps above, the cffconvert
workflow will tell you what content it expected to see in .zenodo.json
. Copy-paste from the GitHub Action log into a new file .zenodo.json
. Afterwards, the cffconvert
GitHub Action should be green.
To help you keep the citation metadata up to date and synchronized, the cffconvert
GitHub Action checks the following 6 aspects:
Whether your repository includes a CITATION.cff
file.
By including this file, authors of the software can receive credit for the work they put in.
Whether your CITATION.cff
is valid YAML.
Visit http://www.yamllint.com/ to see if the contents of your CITATION.cff are valid YAML.
Whether your CITATION.cff
adheres to the schema (as listed in the CITATION.cff
file itself under key cff-version
).
The Citation File Format schema can be found here, along with an explanation of all the keys. You're advised to use the latest available schema version.
Whether your repository includes a .zenodo.json
file.
With this file, you can control what metadata should be associated with any future releases of your software on Zenodo: things like the author names, along with their affiliations and their ORCIDs, the license under which the software has been released, as well as the name of your software and a short description. If your repository doesn't have a .zenodo.json file, Zenodo will take a somewhat crude guess to assign these metadata.
The cffconvert
GitHub action will tell you what it expects to find in .zenodo.json
, just copy and paste it to a new file named .zenodo.json
. The suggested text ignores CITATION.cff's version
, commit
, and date-released
. cffconvert
considers these keys suspect
in the sense that they are often out of date, and there is little purpose to telling Zenodo about these properties: Zenodo already knows.
Whether .zenodo.json
is valid JSON.
Currently unimplemented, but you can check for yourself on https://jsonlint.com/.
Whether CITATION.cff
and .zenodo.json
contain equivalent data.
This final check verifies that the two files are in sync. The check ignores CITATION.cff's version
, commit
, and date-released
.
Continuous code quality can be handled by Sonarcloud. This repository is configured to use Sonarcloud to perform quality analysis and code coverage report on each push.
In order to configure Sonarcloud analysis GitHub Action workflow you must follow the steps below:
Number of days
optionSONAR_TOKEN
to secrets on GitHubYour Python package should have publicly available documentation, including API documentation for your users.
Read the Docs can host your user documentation for you.
To host the documentation of this repository please perform the following instructions:
bvreede/my-python-project
in list and press +
button.
See README.dev.md# how to build documentation site locally.
Your repository has a workflow which lints your code after every push and when creating a pull request.
Linter workflow may fail if description
or keywords
field in setup.cfg is empty. Please update these fields. To validate your changes run:
prospector
Enabling githook will automatically lint your code in every commit. You can enable it by running the command below.
git config --local core.hooksPath .githooks
Continuous code quality can be handled by Sonarcloud. This repository is configured to use Sonarcloud to perform quality analysis and code coverage report on each push.
In order to configure Sonarcloud analysis GitHub Action workflow you must follow the steps below:
Number of days
optionSONAR_TOKEN
to secrets on GitHubIt is likely that your CITATION.cff
currently doesn't pass validation. The error messages you get from the cffconvert
GitHub Action are unfortunately a bit cryptic, but doing the following helps:
given-name
and family-name
keys need updating. If your family name has a name particle like von
or van
or de
, use the name-particle
key; if your name has a suffix like Sr
or IV
, use name-suffix
. For details, refer to the schema description: https://github.com/citation-file-format/citation-file-formatorcid
key. If you do not have an orcid yet, you can get one here https://orcid.org/.date-released
using the YYYY-MM-DD format.doi
key with the conceptDOI for your repository (see https://help.zenodo.org for more information on what a conceptDOI is). If your project doesn't have a DOI yet, you can use the string 10.0000/FIXME
to pass validation.keywords
array accurately describes your project.Once you do all the steps above, the cffconvert
workflow will tell you what content it expected to see in .zenodo.json
. Copy-paste from the GitHub Action log into a new file .zenodo.json
. Afterwards, the cffconvert
GitHub Action should be green.
To help you keep the citation metadata up to date and synchronized, the cffconvert
GitHub Action checks the following 6 aspects:
Whether your repository includes a CITATION.cff
file.
By including this file, authors of the software can receive credit for the work they put in.
Whether your CITATION.cff
is valid YAML.
Visit http://www.yamllint.com/ to see if the contents of your CITATION.cff are valid YAML.
Whether your CITATION.cff
adheres to the schema (as listed in the CITATION.cff
file itself under key cff-version
).
The Citation File Format schema can be found here, along with an explanation of all the keys. You're advised to use the latest available schema version.
Whether your repository includes a .zenodo.json
file.
With this file, you can control what metadata should be associated with any future releases of your software on Zenodo: things like the author names, along with their affiliations and their ORCIDs, the license under which the software has been released, as well as the name of your software and a short description. If your repository doesn't have a .zenodo.json file, Zenodo will take a somewhat crude guess to assign these metadata.
The cffconvert
GitHub action will tell you what it expects to find in .zenodo.json
, just copy and paste it to a new file named .zenodo.json
. The suggested text ignores CITATION.cff's version
, commit
, and date-released
. cffconvert
considers these keys suspect
in the sense that they are often out of date, and there is little purpose to telling Zenodo about these properties: Zenodo already knows.
Whether .zenodo.json
is valid JSON.
Currently unimplemented, but you can check for yourself on https://jsonlint.com/.
Whether CITATION.cff
and .zenodo.json
contain equivalent data.
This final check verifies that the two files are in sync. The check ignores CITATION.cff's version
, commit
, and date-released
.
By enabling Zenodo integration, your package will automatically get a DOI which can be used to cite your package. After enabling Zenodo integration for your GitHub repository, Zenodo will create a snapshot and archive each release you make on GitHub. Moreover, Zenodo will create a new DOI for each GitHub release of your code.
To enable Zenodo integration:
On
toggle button.10.5281/zenodo.1310751
Edit README.md and replace the badge placeholder with the badge link you copied in previous step.
The badge placeholder is shown below.
[![DOI](https://zenodo.org/badge/DOI/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>)
For FAQ about Zenodo please visit https://help.zenodo.org/.
Your Python package should have publicly available documentation, including API documentation for your users.
Read the Docs can host your user documentation for you.
To host the documentation of this repository please perform the following instructions:
bvreede/my-python-project
in list and press +
button.
See README.dev.md# how to build documentation site locally.
By enabling Zenodo integration, your package will automatically get a DOI which can be used to cite your package. After enabling Zenodo integration for your GitHub repository, Zenodo will create a snapshot and archive each release you make on GitHub. Moreover, Zenodo will create a new DOI for each GitHub release of your code.
To enable Zenodo integration:
On
toggle button.10.5281/zenodo.1310751
Edit README.md and replace the badge placeholder with the badge link you copied in previous step.
The badge placeholder is shown below.
[![DOI](https://zenodo.org/badge/DOI/<replace-with-created-DOI>.svg)](https://doi.org/<replace-with-created-DOI>)
For FAQ about Zenodo please visit https://help.zenodo.org/.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.