| Name | nipreps-versions JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | |
| Summary | Version schemes for nipreps tools |
| upload_time | 2023-11-05 02:37:04 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/nipreps-versions/)
[](https://github.com/nipreps/version-schemes/actions/workflows/tox.yml)
# Nipreps version schemes
This package provides a `setuptools_scm` plugin for version schemes used
by the Nipreps family of projects.
## Usage
Add `nipreps_versions` to your `build-system.requires` list, e.g.,
```TOML
[build-system]
requires = [
"flit_scm",
"nipreps_versions",
]
build-backend = "flit_scm:buildapi"
```
or
```TOML
[build-system]
requires = [
"setuptools",
"setuptools_scm",
"nipreps_versions",
]
build-backend = "setuptools.build_meta"
```
Then request a nipreps version scheme:
```TOML
[tool.setuptools_scm]
version_scheme = "nipreps-calver"
```
## Schemes
Currently, only one versioning scheme is implemented:
### `nipreps-calver`
As described in [Releases - Principles](https://www.nipreps.org/devs/releases/#principles),
> The basic release form is `YY.MINOR.PATCH`, so the first minor release of 2020 is 20.0.0, and the first minor release of 2021 will be 21.0.0, whatever the final minor release of 2020 is. A series of releases share a `YY.MINOR`. prefix, which we refer to as the `YY.MINOR.x` series. For example, the 20.0.x series contains version 20.0.0, 20.0.1, and any other releases needed.
If the last tag was 22.1.0 and the year remains 2022, the development version is
`22.2.0.devN`. When the year changes to 2023, the development version will become
`23.0.0.devN`.
If the branch is `maint/22.1.x`, then the computed version will be `22.1.1.devN`.
If the branch is `rel/22.0.3` (and the last tag for that branch is 22.0.2), then
the computed version will be `22.0.3.devN`.
Raw data
{
"_id": null,
"home_page": "",
"name": "nipreps-versions",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Chris Markiewicz <markiewicz@stanford.edu>",
"download_url": "https://files.pythonhosted.org/packages/f7/3c/1a22c36d53405616ddac8dae2e4b467bfa1d634c36fe79a3a161675cb932/nipreps_versions-1.0.4.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/nipreps-versions/)\n[](https://github.com/nipreps/version-schemes/actions/workflows/tox.yml)\n\n# Nipreps version schemes\n\nThis package provides a `setuptools_scm` plugin for version schemes used\nby the Nipreps family of projects.\n\n## Usage\n\nAdd `nipreps_versions` to your `build-system.requires` list, e.g.,\n\n```TOML\n[build-system]\nrequires = [\n \"flit_scm\",\n \"nipreps_versions\",\n]\nbuild-backend = \"flit_scm:buildapi\"\n```\n\nor\n\n```TOML\n[build-system]\nrequires = [\n \"setuptools\",\n \"setuptools_scm\",\n \"nipreps_versions\",\n]\nbuild-backend = \"setuptools.build_meta\"\n```\n\nThen request a nipreps version scheme:\n\n```TOML\n[tool.setuptools_scm]\nversion_scheme = \"nipreps-calver\"\n```\n\n## Schemes\n\nCurrently, only one versioning scheme is implemented:\n\n### `nipreps-calver`\n\nAs described in [Releases - Principles](https://www.nipreps.org/devs/releases/#principles),\n\n> The basic release form is `YY.MINOR.PATCH`, so the first minor release of 2020 is 20.0.0, and the first minor release of 2021 will be 21.0.0, whatever the final minor release of 2020 is. A series of releases share a `YY.MINOR`. prefix, which we refer to as the `YY.MINOR.x` series. For example, the 20.0.x series contains version 20.0.0, 20.0.1, and any other releases needed.\n\nIf the last tag was 22.1.0 and the year remains 2022, the development version is\n`22.2.0.devN`. When the year changes to 2023, the development version will become\n`23.0.0.devN`.\nIf the branch is `maint/22.1.x`, then the computed version will be `22.1.1.devN`.\nIf the branch is `rel/22.0.3` (and the last tag for that branch is 22.0.2), then\nthe computed version will be `22.0.3.devN`.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Version schemes for nipreps tools",
"version": "1.0.4",
"project_urls": {
"Home": "https://github.com/nipreps/version-schemes",
"Nipreps": "https://www.nipreps.org"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e6e7e0e6a46bfa20989bd2dfd958c481ceffd1571e6e62a1c108fbf6d65b9b7",
"md5": "64269ff0c781d7f598b45ddba920bcfc",
"sha256": "cd9912cf5592aad3e5faecc69a231d8581f12112f2722fc4314d114921fda846"
},
"downloads": -1,
"filename": "nipreps_versions-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64269ff0c781d7f598b45ddba920bcfc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7862,
"upload_time": "2023-11-05T02:37:02",
"upload_time_iso_8601": "2023-11-05T02:37:02.947587Z",
"url": "https://files.pythonhosted.org/packages/5e/6e/7e0e6a46bfa20989bd2dfd958c481ceffd1571e6e62a1c108fbf6d65b9b7/nipreps_versions-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f73c1a22c36d53405616ddac8dae2e4b467bfa1d634c36fe79a3a161675cb932",
"md5": "87ebf184ff71d449b66b7dd55c2dee94",
"sha256": "841ff517f320c07193487cf97b90768f1048aef18fac1298b597d9b4972feebf"
},
"downloads": -1,
"filename": "nipreps_versions-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "87ebf184ff71d449b66b7dd55c2dee94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7707,
"upload_time": "2023-11-05T02:37:04",
"upload_time_iso_8601": "2023-11-05T02:37:04.378092Z",
"url": "https://files.pythonhosted.org/packages/f7/3c/1a22c36d53405616ddac8dae2e4b467bfa1d634c36fe79a3a161675cb932/nipreps_versions-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-05 02:37:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nipreps",
"github_project": "version-schemes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "nipreps-versions"
}
