| Name | isospec-data-tools JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | Omics data utilities |
| upload_time | 2025-07-08 14:18:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# isospec-data-tools
[](https://img.shields.io/github/v/release/isospec/isospec-data-tools)
[](https://github.com/isospec/isospec-data-tools/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/isospec/isospec-data-tools)
[](https://img.shields.io/github/commit-activity/m/isospec/isospec-data-tools)
[](https://img.shields.io/github/license/isospec/isospec-data-tools)
Omics data utilities
- **Github repository**: <https://github.com/isospec/isospec-data-tools/>
- **Documentation** <https://isospec.github.io/isospec-data-tools/>
## Getting started with your project
### 1. Create a New Repository
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:isospec/isospec-data-tools.git
git push -u origin main
```
### 2. Set Up Your Development Environment
Then, install the environment and the pre-commit hooks with
```bash
make install
```
This will also generate your `uv.lock` file
### 3. Run the pre-commit hooks
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
```bash
uv run pre-commit run -a
```
### 4. Commit the changes
Lastly, commit the changes made by the two steps above to your repository.
```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```
You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
## Releasing a new version
- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/isospec/isospec-data-tools/settings/secrets/actions/new).
- Create a [new release](https://github.com/isospec/isospec-data-tools/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
Raw data
{
"_id": null,
"home_page": null,
"name": "isospec-data-tools",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "python",
"author": null,
"author_email": "Isospec Analytics <dev@isospec.bio>",
"download_url": "https://files.pythonhosted.org/packages/74/3e/f4134fa4357314fcaa0b986209db58f36e9091bd34e6d4b627a98a73d89d/isospec_data_tools-0.0.3.tar.gz",
"platform": null,
"description": "# isospec-data-tools\n\n[](https://img.shields.io/github/v/release/isospec/isospec-data-tools)\n[](https://github.com/isospec/isospec-data-tools/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/isospec/isospec-data-tools)\n[](https://img.shields.io/github/commit-activity/m/isospec/isospec-data-tools)\n[](https://img.shields.io/github/license/isospec/isospec-data-tools)\n\nOmics data utilities\n\n- **Github repository**: <https://github.com/isospec/isospec-data-tools/>\n- **Documentation** <https://isospec.github.io/isospec-data-tools/>\n\n## Getting started with your project\n\n### 1. Create a New Repository\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:isospec/isospec-data-tools.git\ngit push -u origin main\n```\n\n### 2. Set Up Your Development Environment\n\nThen, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nThis will also generate your `uv.lock` file\n\n### 3. Run the pre-commit hooks\n\nInitially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:\n\n```bash\nuv run pre-commit run -a\n```\n\n### 4. Commit the changes\n\nLastly, commit the changes made by the two steps above to your repository.\n\n```bash\ngit add .\ngit commit -m 'Fix formatting issues'\ngit push origin main\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [PyPI](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/isospec/isospec-data-tools/settings/secrets/actions/new).\n- Create a [new release](https://github.com/isospec/isospec-data-tools/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).\n",
"bugtrack_url": null,
"license": null,
"summary": "Omics data utilities",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://isospec.github.io/isospec-data-tools/",
"Homepage": "https://isospec.github.io/isospec-data-tools/",
"Repository": "https://github.com/isospec/isospec-data-tools"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1b9bd9d476ed18462988146590535e603341b379f52aa0da8079328bd0287566",
"md5": "0a3a62b42a2e9fc7bcfd323a38e9ee52",
"sha256": "2aa8459893b93f7173b149ac57ade9ddbb147c96e4ab53bb4bab698e15593b3a"
},
"downloads": -1,
"filename": "isospec_data_tools-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a3a62b42a2e9fc7bcfd323a38e9ee52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 89594,
"upload_time": "2025-07-08T14:18:47",
"upload_time_iso_8601": "2025-07-08T14:18:47.475142Z",
"url": "https://files.pythonhosted.org/packages/1b/9b/d9d476ed18462988146590535e603341b379f52aa0da8079328bd0287566/isospec_data_tools-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "743ef4134fa4357314fcaa0b986209db58f36e9091bd34e6d4b627a98a73d89d",
"md5": "30b61b33f555002aec38f5a51ab0abac",
"sha256": "57e011d76c5dd68c00fb8744b222b723c1cffcd87b7c8a54a1d37a4d56781ed4"
},
"downloads": -1,
"filename": "isospec_data_tools-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "30b61b33f555002aec38f5a51ab0abac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 244332,
"upload_time": "2025-07-08T14:18:48",
"upload_time_iso_8601": "2025-07-08T14:18:48.770469Z",
"url": "https://files.pythonhosted.org/packages/74/3e/f4134fa4357314fcaa0b986209db58f36e9091bd34e6d4b627a98a73d89d/isospec_data_tools-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 14:18:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "isospec",
"github_project": "isospec-data-tools",
"github_not_found": true,
"lcname": "isospec-data-tools"
}
