| Name | tubescience-cli JSON |
| Version |
0.0.10
JSON |
| download |
| home_page | None |
| Summary | TubeScience CLI tools |
| upload_time | 2024-12-17 18:06:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tubescience-cli
[](https://img.shields.io/github/v/release/jmosbacher/tubescience-cli)
[](https://github.com/jmosbacher/tubescience-cli/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/jmosbacher/tubescience-cli)
[](https://img.shields.io/github/commit-activity/m/jmosbacher/tubescience-cli)
[](https://img.shields.io/github/license/jmosbacher/tubescience-cli)
TubeScience CLI tools
- **Github repository**: <https://github.com/jmosbacher/tubescience-cli/>
- **Documentation** <https://jmosbacher.github.io/tubescience-cli/>
## 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:jmosbacher/tubescience-cli.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/jmosbacher/tubescience-cli/settings/secrets/actions/new).
- Create a [new release](https://github.com/jmosbacher/tubescience-cli/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).
---
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
Raw data
{
"_id": null,
"home_page": null,
"name": "tubescience-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python",
"author": null,
"author_email": "Yossi Mosbacher <yossi.mosbacher@tubescience.com>",
"download_url": "https://files.pythonhosted.org/packages/28/8b/4cad446d4846cd3bac84040fae383ef15677ee36285bc2a1dabf18f5fea0/tubescience_cli-0.0.10.tar.gz",
"platform": null,
"description": "# tubescience-cli\n\n[](https://img.shields.io/github/v/release/jmosbacher/tubescience-cli)\n[](https://github.com/jmosbacher/tubescience-cli/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/jmosbacher/tubescience-cli)\n[](https://img.shields.io/github/commit-activity/m/jmosbacher/tubescience-cli)\n[](https://img.shields.io/github/license/jmosbacher/tubescience-cli)\n\nTubeScience CLI tools\n\n- **Github repository**: <https://github.com/jmosbacher/tubescience-cli/>\n- **Documentation** <https://jmosbacher.github.io/tubescience-cli/>\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:jmosbacher/tubescience-cli.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/jmosbacher/tubescience-cli/settings/secrets/actions/new).\n- Create a [new release](https://github.com/jmosbacher/tubescience-cli/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\n---\n\nRepository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).\n",
"bugtrack_url": null,
"license": null,
"summary": "TubeScience CLI tools",
"version": "0.0.10",
"project_urls": {
"Documentation": "https://jmosbacher.github.io/tubescience-cli/",
"Homepage": "https://jmosbacher.github.io/tubescience-cli/",
"Repository": "https://github.com/jmosbacher/tubescience-cli"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "149405a96141469825d84e3a08766979698a494a3b7ab594de86b7e500eaea34",
"md5": "51cca696b9ca0500f0a2a61fd8eec1ad",
"sha256": "1e4d8ba7071f5125197f0e1258aa6504c156857724634e7d7fc3429066971809"
},
"downloads": -1,
"filename": "tubescience_cli-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51cca696b9ca0500f0a2a61fd8eec1ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 17082,
"upload_time": "2024-12-17T18:06:23",
"upload_time_iso_8601": "2024-12-17T18:06:23.626854Z",
"url": "https://files.pythonhosted.org/packages/14/94/05a96141469825d84e3a08766979698a494a3b7ab594de86b7e500eaea34/tubescience_cli-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "288b4cad446d4846cd3bac84040fae383ef15677ee36285bc2a1dabf18f5fea0",
"md5": "dbe54283611da11ba80249562348aa44",
"sha256": "ca1ddbc54cc898134a71ad982c4982e873952e7890c8e19e36801228f0d849cf"
},
"downloads": -1,
"filename": "tubescience_cli-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "dbe54283611da11ba80249562348aa44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 99268,
"upload_time": "2024-12-17T18:06:24",
"upload_time_iso_8601": "2024-12-17T18:06:24.833841Z",
"url": "https://files.pythonhosted.org/packages/28/8b/4cad446d4846cd3bac84040fae383ef15677ee36285bc2a1dabf18f5fea0/tubescience_cli-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 18:06:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmosbacher",
"github_project": "tubescience-cli",
"github_not_found": true,
"lcname": "tubescience-cli"
}
