The scientific-python.org website is built using scientific-python-hugo-theme and Hugo.
It is deployed via Netlify when commits changes are made to the main branch.
Please download the latest binary from
https://github.com/gohugoio/hugo/releases
and place it somewhere on your path.
For development, start the development server using
make serve-dev
and browse to http://localhost:1313.
Create a personal access token
with access read:org.
export GH_TOKEN=<personal-access-token>
Then run make teams.
A self-hosted version of Plausible.io is used to gather simple and privacy-friendly analytics for the site. The dashboard can be accessed here.
If you wish to contribute to scientific-python.org:
- Fork and clone the repository
- Create a new branch with your proposed feature or change to the package repository
We use pre-commit to ensure the code style is consistent. To install pre-commit locally:
- First install pre-commit:
pip install pre-commit - Install all of the pre-commit hooks by running
pre-commit install
Once you have pre-commit installed, the code stylers and linters
defined in the .pre-commit-config.yaml will run each time you
commit modified changes to git locally.
We use the pre-commit CI bot to run linting tests and to auto fix pull requests. How it works:
- Pre-commit.ci will run the CI checks via a CI run in the PR.
- After the PR is approved but before it's merged, a maintainer can run the bot to apply linting fixes via a commit to the PR. To run the bot write:
pre-commit.ci autofix in a comment in the PR. This will trigger another CI run to double check that the linting / code style fixes are as expected. Then you can merge!
NOTE: the pre-commit CI bot CI action will allow you to see what checks pass. It will also remind you of the command to autofix the code in the pr.