This page provides procedures and guidelines for developing and contributing to neophile.
Scope of contributions#
neophile is an open source package, meaning that you can contribute to neophile itself, or fork neophile for your own purposes.
Since neophile is intended for internal use by Rubin Observatory, community contributions can only be accepted if they align with Rubin Observatory’s aims. For that reason, it’s a good idea to propose changes with a new GitHub issue before investing time in making a pull request.
neophile is developed by the Rubin Observatory SQuaRE team.
Setting up a local development environment#
To develop neophile, create a virtual environment with your method of choice (like virtualenvwrapper) and then clone or fork, and install:
git clone https://github.com/lsst-sqre/neophile.git
This init step does three things:
Installs neophile in an editable mode with its “dev” extra that includes test and documentation dependencies.
Installs pre-commit and tox.
Installs the pre-commit hooks.
The pre-commit hooks, which are automatically installed by running the make init command on set up, ensure that files are valid and properly formatted. Some pre-commit hooks automatically reformat code:
Lint Python code and attempt to automatically fix some problems.
Automatically formats Python code.
Automatically formats Python code in reStructuredText documentation and docstrings.
When these hooks fail, your Git commit will be aborted. To proceed, stage the new modifications and proceed with your Git commit.
To test nephile, run tox, which tests it the same way that the CI workflow does:
To run the tests with coverage analysis and generate a report, run:
tox run -e py,coverage-report
To see a listing of test environments, run:
To run a specific test or list of tests, you can add test file names (and any other pytest options) after
-- when executing the
py tox environment.
tox run -e py -- tests/handlers/api_tokens_test.py
Documentation is built with Sphinx:
tox run -e docs
The build documentation is located in the
To check the documentation for broken links, run:
tox run -e docs-linkcheck
Updating the change log#
neophile uses scriv to maintain its change log.
When preparing a pull request, run scriv create.
This will create a change log fragment in
Edit that fragment, removing the sections that do not apply and adding entries fo this pull request.
You can pass the
--edit flag to scriv create to open the created fragment automatically in an editor.
Change log entries use the following sections:
Other changes (for minor, patch-level changes that are not bug fixes, such as logging formatting changes or updates to the documentation)
These entries will eventually be cut and pasted into the release description for the next release, so the Markdown for the change descriptions must be compatible with GitHub’s Markdown conventions for the release description. Specifically:
Each bullet point should be entirely on one line, even if it contains multiple sentences. This is an exception to the normal documentation convention of a newline after each sentence. Unfortunately, GitHub interprets those newlines as hard line breaks, so they would result in an ugly release description.
Avoid using too much complex markup, such as nested bullet lists, since the formatting in the GitHub release description may not be what you expect and manually editing it is tedious.
neophile mostly follows the SQR-072 Python style guide, although the code layout does not match that document.
The code style follows PEP 8, though in practice lean on Black and isort to format the code for you.
neophile uses the Ruff linter with most checks enabled. Try to avoid
noqamarkers except for issues that need to be fixed in the future. Tests that generate false positives should normally be disabled, but if the lint error can be avoided with minor rewriting that doesn’t make the code harder to read, prefer the rewriting.
Write tests for Pytest.
Document the Python API with numpydoc-formatted docstrings. See the LSST DM Docstring Style Guide.
Follow the LSST DM ReStructuredTextStyle Guide. In particular, ensure that prose is written one-sentence-per-line for better Git diffs.