Skip to main content

Python code for causal modeling.

Project description

y0

Tests Cookiecutter template from @cthoyt PyPI PyPI - Python Version PyPI - License Documentation Status DOI

Python code for causal modeling.

💪 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 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 .

⚖️ License

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

🙏 Contributing

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

🍪 Cookiecutter Acknowledgement

This package was created with @audreyr's cookiecutter package using @cthoyt's cookiecutter-python-package template.

🛠️ Development

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

❓ 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.

📦 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 BumpVersion to switch the version number in the setup.cfg and src/y0/version.py to not have the -dev suffix
  2. Packages the code in both a tar archive and a wheel
  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

y0-0.0.2.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

y0-0.0.2-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: y0-0.0.2.tar.gz
  • Upload date:
  • Size: 31.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for y0-0.0.2.tar.gz
Algorithm Hash digest
SHA256 1de1ced1a91c3d73822a1c568975f0d35b4ae68b1bd6099fe79f15f0afc0d589
MD5 c0083604841a7fd40c6c45231c792378
BLAKE2b-256 7725becdcfa67e301feba6a442faf2525bc773ca76bb5c3e9f172a04a0f1603f

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: y0-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for y0-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1beb7afc31543c9847e544555ce2043b23fbcb201c20ea3022fede644b23a278
MD5 3e1ecbbd2553babfd4e4d4bc55db4068
BLAKE2b-256 28ce0bd3858eee36de394b2059925c3a320c105f78d725b6ea785b1b852b35f3

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