Python code for causal modeling.
TODO show in a very small amount of space the MOST useful thing your package can do. Make it as short as possible! You have an entire set of docs for later.
The most recent release can be installed from PyPI with:
$ pip install y0
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/y0-causal-inference/y0.git
To install in development mode, use the following:
$ git clone git+https://github.com/y0-causal-inference/y0.git
$ cd y0
$ pip install -e .
The code in this package is licensed under the MIT License.
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
This package was created with @audreyr's cookiecutter package using @cthoyt's cookiecutter-python-package template.
The final section of the README is for if you want to get involved by making a code contribution.
After cloning the repository and installing tox
with pip install tox
, the unit tests in the tests/
folder can be
run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
After installing the package in development mode and installing
tox
with pip install tox
, the commands for making a new release are contained within the finish
environment
in tox.ini
. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses BumpVersion to switch the version number in the
setup.cfg
andsrc/y0/version.py
to not have the-dev
suffix - Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine
. Be sure to have a.pypirc
file configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use
tox -e bumpversion minor
after.