If you are interested in contributing to genslm, your contributions will fall into two categories:
- You want to implement a new feature:
- In general, we accept any features as long as they fit the scope of this package. If you are unsure about this or need help on the design/implementation of your feature, post about it in an issue.
- You want to fix a bug:
- Please post an issue using the Bug template which provides a clear and concise description of what the bug was.
Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/ramanathanlab/genslm.
To develop genslm on your machine, please follow these instructions:
- Clone a copy of genslm from source:
git clone https://github.com/ramanathanlab/genslm
cd genslm
- If you already have a genslm from source, update it:
git pull
- Install genslm in
develop
mode:
python -m venv env
source env/bin/activate
pip install -U pip setuptools wheel
pip install -r requirements/dev.txt
pip install -e .
This mode will symlink the Python files from the current local source tree into the Python install. Hence, if you modify a Python file, you do not need to reinstall genslm again and again.
- Ensure that you have a working genslm installation by running:
python -c "import genslm; print(genslm.__version__)"
- To run dev tools (isort, flake8, black, mypy, coverage, pygount):
make
make mypy
make coverage
make pygount
To run the test suite:
- Build and install genslm from source.
- Run the test suite:
pytest tests
If contributing, please add a test_<module_name>.py
in the tests/
directory
in a subdirectory that matches the genslm package directory structure. Inside,
test_<module_name>.py
implement test functions using pytest.
To build the documentation:
- Build and install genslm from source.
- Generate the documentation file via:
cd genslm/docs
make html
The docs are located in genslm/docs/build/html/index.html
.
To view the docs run: open genslm/docs/build/html/index.html
.
To release a new version of genslm to PyPI:
- Merge the
develop
branch into themain
branch with an updated version number ingenslm.__init__
. - Make a new release on GitHub with the tag and name equal to the version number with a "v" in front, e.g.,
v<version-number>
. - Build and install genslm from source.
- Run the following commands:
python setup.py sdist
twine upload dist/*
To setup the docker container and push to docker hub:
cd requirements
docker login
docker build . -t genslm
docker tag genslm abrace05/genslm
docker push abrace05/genslm
Check that the container runs:
docker run -it --rm abrace05/genslm bash