Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhsdigital/codonpython
The codon project was created to increase code sharing, code consistency, coding standards, and encourage collaboration. Package documentation is available on the GitHub pages. codonPython aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability.
https://github.com/nhsdigital/codonpython
codon codonpython healthcare nhs nhs-digital rap reproducible-analytical-pipeline
Last synced: 11 days ago
JSON representation
The codon project was created to increase code sharing, code consistency, coding standards, and encourage collaboration. Package documentation is available on the GitHub pages. codonPython aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability.
- Host: GitHub
- URL: https://github.com/nhsdigital/codonpython
- Owner: NHSDigital
- License: bsd-3-clause
- Created: 2019-12-16T13:06:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T13:41:53.000Z (about 2 months ago)
- Last Synced: 2024-11-06T14:37:12.493Z (about 2 months ago)
- Topics: codon, codonpython, healthcare, nhs, nhs-digital, rap, reproducible-analytical-pipeline
- Language: Python
- Homepage:
- Size: 9.29 MB
- Stars: 5
- Watchers: 5
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# codonPython
[](https://travis-ci.com/codonlibrary/codonPython)
[](https://codecov.io/gh/codonlibrary/codonPython)
[](https://github.com/psf/black)
## What is `codon`?
The `codon` project was created to increase code sharing, code consistency, coding standards, and encourage collaboration. Package documentation is available on the [GitHub pages](https://codonlibrary.github.io/codonPython/). `codonPython` aims to reduce the barrier for entry for analysis and provide software development experience for those at a higher level of technical ability.
### Why `codon`?
In biological terms, a `codon` is one of the building blocks that make up our DNA. By openly sharing our code we hope that others will be able to take those blocks of code to build their own processes using the data that NHS Digital hold.
By sharing code, the project aims to:
**Increase Transparency**: To align with government data principles and build public trust.
**Improve Code**: To innovate and improve the code we use and provide.
**Improve usability**: By increasing the accessibility and uniformity of code, it becomes easier for data users to find and use relevant code.
**Be more cost effective**: Reusable 'generalised' code will increase efficiency in creating higher level processes.
## Installation
The package can be directly installed by typing in your terminal:
```r
python -m pip install --user git+https://github.com/codonlibrary/codonPython.git
```
For further guidance on cloning from the remote repository to a local repository on your machine see the information in our [Wiki.](https://github.com/codonlibrary/codonPython/wiki/1.-Installing-codonPython)
## Contributing to codonPython
All new contributions to `codon` are welcome; please follow the Coding Conventions in the [guidance document](https://github.com/codonlibrary/codonPython/blob/master/CONTRIBUTING.md) for contribution guidance.
Any improvements to documentation, bug fixes or general code enhancements are also welcomed. If a bug is found on the master branch, please use the GitHub guidance on raising an [issue.](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue)
## New to GitHub?
GitHub is a hosting site that allows for development and version control of software using Git. It allows users to edit and develop parts of code independently before submitting back to the master code, whilst using version control to track changes. Introductory videos to GitHub for beginners can be found [here.](https://github.com/codonlibrary/codonPython/wiki/2a.-GitHub-for-Beginners)
Quick links to beginner guidance can also be found below:
* [**Cloning a repository to your local machine using GitBash**](https://github.com/codonlibrary/codonPython/wiki/1.-Installing-codonPython)
* [**Checking out a branch using GitBash**](https://github.com/codonlibrary/codonPython/wiki/2b.-Checkout-a-branch-using-GitBash)
* [**Removing a Commit from a repository using GitBash**](https://github.com/codonlibrary/codonPython/wiki/3.-Removing-a-Commit-From-a-GitHub-Repository)
All other `codon` "How-to Articles" can be found [here.](https://github.com/codonlibrary/codonPython/wiki/2.-Git-Guidance)
Suggestions regarding additional guidance or How-to articles are welcome.