Skip to main content

A high level, end-to-end causal inference workflow.

Project description

Eliater

Tests PyPI PyPI - Python Version PyPI - License Documentation Status Codecov status Cookiecutter template from @cthoyt Code style: black Contributor Covenant

A high level, end-to-end causal inference workflow.

💪 Getting Started

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.

🚀 Installation

The most recent release can be installed from PyPI with:

$ pip install eliater

The most recent code and data can be installed directly from GitHub with:

$ pip install git+https://github.com/y0-causal-inference/eliater.git

👐 Contributing

Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.

👋 Attribution

⚖️ License

The code in this package is licensed under the MIT License.

🍪 Cookiecutter

This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.

🛠️ For Developers

See developer instructions

The final section of the README is for if you want to get involved by making a code contribution.

Development Installation

To install in development mode, use the following:

$ git clone git+https://github.com/y0-causal-inference/eliater.git
$ cd eliater
$ pip install -e .

🥼 Testing

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.

📖 Building the Documentation

The documentation can be built locally using the following:

$ git clone git+https://github.com/y0-causal-inference/eliater.git
$ cd eliater
$ tox -e docs
$ open docs/build/html/index.html

The documentation automatically installs the package as well as the docs extra specified in the setup.cfg. sphinx plugins like texext can be added there. Additionally, they need to be added to the extensions list in docs/source/conf.py.

📦 Making a Release

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:

  1. Uses Bump2Version to switch the version number in the setup.cfg, src/eliater/version.py, and docs/source/conf.py to not have the -dev suffix
  2. Packages the code in both a tar archive and a wheel using build
  3. Uploads to PyPI using twine. Be sure to have a .pypirc file configured to avoid the need for manual input at this step
  4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
  5. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eliater-0.0.2.tar.gz (976.2 kB view details)

Uploaded Source

Built Distribution

eliater-0.0.2-py3-none-any.whl (196.2 kB view details)

Uploaded Python 3

File details

Details for the file eliater-0.0.2.tar.gz.

File metadata

  • Download URL: eliater-0.0.2.tar.gz
  • Upload date:
  • Size: 976.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for eliater-0.0.2.tar.gz
Algorithm Hash digest
SHA256 d74498cc22036f727c1d6dd577915a3019b0d655a5e2ed742fa18d9939f87510
MD5 8cd85c81d129b6eede2f37421c7dceb0
BLAKE2b-256 3a4119d6e283353b1d14e73bdbe60c8db56cfc7ab1fee7f3db11bda7192aaca1

See more details on using hashes here.

Provenance

File details

Details for the file eliater-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: eliater-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 196.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for eliater-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 61f884a197c735ec3d1e0a060309d75b7e3e0d160f3c37dd5a7aeeb49db6d371
MD5 cea62ecd410f776cebd8d716ebfb3ecd
BLAKE2b-256 92b590c77f1400bc5a95f51c1473a972564a3a65ce576285942741fa962c40ad

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page