Skip to main content

RefChef

Travis Coverage Docs License PyPi

RefChef is a reference management tool used to (1) document the exact steps undertaken in the retrieval of genomic references, (2) maintain the associated metadata, (3) provide a mechanism for automatically reproducing retrieval and creation of an exact copy of genomic references.

Installation

To install from PyPI using pip:
pip install refchef
To install using Anaconda Python:
conda install -c compbiocore refchef

Development

To install a development version from the current directory:

git clone https://github.com/compbiocore/refchef.git
cd refchef
pip install -e .

Run unit tests as: python setup.py test

Set up .env file with GitHub Access Token

Sensitive environment variables are stored in the .env file. This file is included in .gitignore intentionally, so that it is never committed. - Create a .env file and copy into it the contents of .env.template - Get your GitHub Access Token and add to the .env file.

Contributing

Contributions consistent with the style and quality of existing code are welcome. Be sure to follow the guidelines below.

Check the issues page of this repository for available work.

Committing

This project uses commitizen to ensure that commit messages remain well-formatted and consistent across different contributors.

Before committing for the first time, install commitizen and read Conventional Commits.

pip install commitizen

To start work on a new change, pull the latest develop and create a new topic branch (e.g. feature-resume-model, chore-test-update, bugfix-bad-bug).

git add .

To commit, run the following command (instead of git commit) and follow the directions:

cz commit

Contact

Contact cbc-help@brown.edu - this is our general help line, so please specify that your issue is with this site’s contents

Metadata

Release files for refchef 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for refchef 1.0.1
File Size Uploaded
refchef-1.0.1.tar.gz 12.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for refchef 1.0.1
File Interpreter ABI Platform
refchef-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 41.5 kB

Release files / refchef-1.0.1.tar.gz

Download URL refchef-1.0.1.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
3088ff9c5ea1c3167b84d3301c5b0de8a0dcb462b7989e08791a280d83a07e6f
BLAKE2b-256 checksum
How to use checksums
518af89dcc5dcf1ee11403085d3753ed1cbb56dc6f434afb7fe3fb2463c241eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

Release files / refchef-1.0.1-py3-none-any.whl

Download URL refchef-1.0.1-py3-none-any.whl
Size 29.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
03ebae2515da0abb1f8a74ba76abc7680a952ee921d1a92d5761b81e820ee1f8
BLAKE2b-256 checksum
How to use checksums
607fd0a0f670fa4dd145655d2bfd49a4e1a226e6d6873e26573060033f71f7a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page