Skip to content

Contributing

Parsita is free and open source software developed under an MIT license. Development occurs at the GitHub project. Contributions, big and small, are welcome.

Bug reports and feature requests may be made directly on the issues tab.

To make a pull request, you will need to fork the repo, clone the repo, make the changes, run the tests, push the changes, and open a PR.

Cloning the repo

To make a local copy of Parsita, clone the repository with git:

git clone https://github.com/drhagen/parsita.git

Installing from source

Parsita uses Poetry as its packaging and dependency manager. In whatever Python environment you prefer, install Poetry and then use Poetry to install Parsita and its dependencies:

pip install poetry
poetry install

Testing

Parsita uses pytest to run the tests in the tests/ directory. The test command is encapsulated with Nox:

poetry run nox -s test

This will try to test with all compatible Python versions that nox can find. To run the tests with only a particular version, run something like this:

poetry run nox -s test-3.9

It is good to run the tests locally before making a PR, but it is not necessary to have all Python versions run. It is rare for a failure to appear in a single version, and the CI will catch it anyway.

Code quality

Parsita uses Ruff to ensure a minimum standard of code quality. The code quality commands are encapsulated with Nox:

poetry run nox -s format
poetry run nox -s lint

Generating the docs

Parsita uses MkDocs to generate HTML docs from Markdown. For development purposes, they can be served locally without needing to build them first:

poetry run mkdocs serve

To deploy the current docs to GitHub Pages, Parsita uses the MkDocs gh-deploy command that builds the static site on the gh-pages branch, commits, and pushes to the origin:

poetry run mkdocs gh-deploy

Making a release

  1. Bump
    1. Increment version in pyproject.toml
    2. Commit with message "Bump version number to X.Y.Z"
    3. Push commit to GitHub
    4. Check CI to ensure all tests pass
  2. Tag
    1. Tag commit with "vX.Y.Z"
    2. Push tag to GitHub
    3. Wait for build to finish
    4. Check PyPI for good upload
  3. Publish to conda-forge
    1. Fork parsita-feedstock
    2. Create branch with name vX.Y.Z
    3. Update recipe/meta.yaml
      • Update version
      • Update sha256 to match source tarball on PyPI
      • Reset build number to 0
      • Update requirements and other project metadata
    4. Commit with message "updated vX.Y.Z"
    5. Push to fork
    6. Open PR on upstream
    7. Wait for build to succeed
    8. Squash merge PR
  4. Document
    1. Create GitHub release with name "Parsita X.Y.Z" and major changes in body
    2. If appropriate, deploy updated docs