inspire-schemas
INSPIRE JSON schemas and related tools.
Installation
Requires Python 3.11 or newer. Install from PyPI:
pip install inspire-schemas
Docker
Install Docker, then build the image from the repository root:
docker build -t inspire-schemas .
Start a shell inside the container, then run the tests:
docker run -it inspire-schemas
pytest tests/
The image build already installs dependencies and generates the schema JSON files, so the container is ready to test as soon as it starts.
Contributing
Bug fixes, features, and documentation improvements are welcome. Use the issue tracker to report bugs or suggest features. For bugs, include your operating system, relevant setup details, and steps to reproduce. For features, explain the proposed behavior and keep the scope focused.
Development setup
Fork inspire-schemas, then clone your fork. Install Python 3.11 or newer and Poetry, and run:
git clone git@github.com:your_name_here/inspire-schemas.git
cd inspire-schemas
poetry install --with test,docs
poetry run python -m scripts.generate_schemas
git checkout -b name-of-your-bugfix-or-feature
The generate_schemas script resolves the .yml schema sources under
inspire_schemas/records into the .json files the library loads at
runtime; it must be re-run after pulling changes to any schema.
Run the test suite:
poetry run pytest
The test run reports coverage, including missing lines. Code style is checked separately by pre-commit in CI.
Pull requests
- Include tests and avoid decreasing test coverage.
- Update documentation and add docstrings for new functionality.
- Ensure GitHub Actions passes on all supported Python versions, starting with Python 3.11.
Commit with a sign-off and a descriptive message, push your branch, and open a pull request on GitHub:
git add .
git commit -s -m "component: describe your change"
git push origin name-of-your-bugfix-or-feature
When applicable, include Sem-Ver: new feature or Sem-Ver: breaks api in
the commit message body.
2 maintainers
Metadata
2 maintainers
Release files for inspire-schemas 61.6.34
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| inspire_schemas-61.6.34.tar.gz | 177.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| inspire_schemas-61.6.34-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 427.2 kB
Release files / inspire_schemas-61.6.34.tar.gz
| Download URL | inspire_schemas-61.6.34.tar.gz |
|---|---|
| Size | 177.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3a2af628cd8f291b8102c5ab545cd191463090974a0d00a28e739d5ccabe7b97
|
|
BLAKE2b-256 checksum How to use checksums |
42726d3d3da292d6e6ba9fb395f71394afce61e27c2ca3a9f8092b6405adefc9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / inspire_schemas-61.6.34-py3-none-any.whl
| Download URL | inspire_schemas-61.6.34-py3-none-any.whl |
|---|---|
| Size | 249.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
327b35341c51203eb100fc32b0526655bac797a002f1f55d0a6a2bd69563e0e8
|
|
BLAKE2b-256 checksum How to use checksums |
7bb65bd15c18a691f09ad64f94e1c34840d58938ab069f5ef72e370ea48cf2de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
