| Name | lzqueue JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Lazy queue (lzqueue) |
| upload_time | 2025-01-21 19:59:31 |
| 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.
|
# lzqueue
[](https://img.shields.io/github/v/release/lzkit/lzqueue)
[](https://github.com/lzkit/lzqueue/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/lzkit/lzqueue)
[](https://img.shields.io/github/commit-activity/m/lzkit/lzqueue)
[](https://img.shields.io/github/license/lzkit/lzqueue)
Lazy queue (lzqueue)
- **Github repository**: <https://github.com/lzkit/lzqueue/>
- **Documentation** <https://lzkit.com/lzqueue/>
## 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:lzkit/lzqueue.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/lzkit/lzqueue/settings/secrets/actions/new).
- Create a [new release](https://github.com/lzkit/lzqueue/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": "lzqueue",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python",
"author": null,
"author_email": "Ian Maurer <imaurer@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1a/51/b8e13ae77acb9520f5ab395025b2e69420013471a2754a7cab04a5fb3b0c/lzqueue-0.0.1.tar.gz",
"platform": null,
"description": "# lzqueue\n\n[](https://img.shields.io/github/v/release/lzkit/lzqueue)\n[](https://github.com/lzkit/lzqueue/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/lzkit/lzqueue)\n[](https://img.shields.io/github/commit-activity/m/lzkit/lzqueue)\n[](https://img.shields.io/github/license/lzkit/lzqueue)\n\nLazy queue (lzqueue)\n\n- **Github repository**: <https://github.com/lzkit/lzqueue/>\n- **Documentation** <https://lzkit.com/lzqueue/>\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:lzkit/lzqueue.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/lzkit/lzqueue/settings/secrets/actions/new).\n- Create a [new release](https://github.com/lzkit/lzqueue/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": "Lazy queue (lzqueue)",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://lzkit.com/lzqueue",
"Homepage": "https://lzkit.com/lzqueue",
"Repository": "https://github.com/lzkit/lzqueue"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2e844c915e19014029c408061a973905c4771e063de1ff8b89c6931efbb1936c",
"md5": "c06025d8a34f885b0319b95e0e408017",
"sha256": "1ac350792c5f254b68d778cd77ba3ab4785dba2f1ecb162b6ec4f67fe3ddde96"
},
"downloads": -1,
"filename": "lzqueue-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c06025d8a34f885b0319b95e0e408017",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 15394,
"upload_time": "2025-01-21T19:59:29",
"upload_time_iso_8601": "2025-01-21T19:59:29.182438Z",
"url": "https://files.pythonhosted.org/packages/2e/84/4c915e19014029c408061a973905c4771e063de1ff8b89c6931efbb1936c/lzqueue-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1a51b8e13ae77acb9520f5ab395025b2e69420013471a2754a7cab04a5fb3b0c",
"md5": "b93de661612cc3e710c1c3bdd0363377",
"sha256": "e8e6ee9e82af7cfa9a4c6f96e0c497e09a4962aad273bf6e7f336877d9d275b4"
},
"downloads": -1,
"filename": "lzqueue-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b93de661612cc3e710c1c3bdd0363377",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 18503,
"upload_time": "2025-01-21T19:59:31",
"upload_time_iso_8601": "2025-01-21T19:59:31.043779Z",
"url": "https://files.pythonhosted.org/packages/1a/51/b8e13ae77acb9520f5ab395025b2e69420013471a2754a7cab04a5fb3b0c/lzqueue-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 19:59:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lzkit",
"github_project": "lzqueue",
"github_not_found": true,
"lcname": "lzqueue"
}
