# Zrb extras
zrb-extras is a [pypi](https://pypi.org) package.
You can install zrb-extras by invoking the following command:
```bash
pip install zrb-extras
```
Once zrb-extras is installed, you can then run it by invoking the following command:
```bash
zrb-extras
```
You can also import `zrb-extras` into your Python program:
```python
from zrb_extras import hello
print(hello())
```
# For maintainers
## Publish to pypi
To publish zrb-extras, you need to have a `Pypi` account:
- Log in or register to [https://pypi.org/](https://pypi.org/)
- Create an API token
You can also create a `TestPypi` account:
- Log in or register to [https://test.pypi.org/](https://test.pypi.org/)
- Create an API token
Once you have your API token, you need to create a `~/.pypirc` file:
```
[distutils]
index-servers =
pypi
testpypi
[pypi]
repository = https://upload.pypi.org/legacy/
username = __token__
password = pypi-xxx-xxx
[testpypi]
repository = https://test.pypi.org/legacy/
username = __token__
password = pypi-xxx-xxx
```
To publish zrb-extras, you can do the following command:
```bash
zrb project publish-zrb-extras
```
## Updating version
You can update zrb-extras version by modifying the following section in `pyproject.toml`:
```toml
[project]
version = "0.0.2"
```
## Adding dependencies
To add zrb-extras dependencies, you can edit the following section in `pyproject.toml`:
```toml
[project]
dependencies = [
"Jinja2==3.1.2",
"jsons==1.6.3"
]
```
## Adding script
To make zrb-extras executable, you can edit the following section in `pyproject.toml`:
```toml
[project-scripts]
zrb-extras-hello = "zrb_extras.__main__:hello"
```
Now, whenever you run `zrb-extras-hello`, the `main` function on your `__main__.py` will be executed.
Raw data
{
"_id": null,
"home_page": "https://github.com/goFrendiAsgard/zrb-extras",
"name": "zrb-extras",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.10.0",
"maintainer_email": null,
"keywords": null,
"author": "Go Frendi Gunawan",
"author_email": "gofrendiasgard@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bb/96/2b1dce011410b97bc0bc869d5bec6e8c6aa02a7955a847af591207f19ac1/zrb_extras-0.0.6.tar.gz",
"platform": null,
"description": "# Zrb extras\n\nzrb-extras is a [pypi](https://pypi.org) package.\n\nYou can install zrb-extras by invoking the following command:\n\n```bash\npip install zrb-extras\n```\n\nOnce zrb-extras is installed, you can then run it by invoking the following command:\n\n```bash\nzrb-extras\n```\n\nYou can also import `zrb-extras` into your Python program:\n\n```python\nfrom zrb_extras import hello\n\nprint(hello())\n```\n\n\n# For maintainers\n\n## Publish to pypi\n\nTo publish zrb-extras, you need to have a `Pypi` account:\n\n- Log in or register to [https://pypi.org/](https://pypi.org/)\n- Create an API token\n\nYou can also create a `TestPypi` account:\n\n- Log in or register to [https://test.pypi.org/](https://test.pypi.org/)\n- Create an API token\n\nOnce you have your API token, you need to create a `~/.pypirc` file:\n\n```\n[distutils]\nindex-servers =\n pypi\n testpypi\n\n[pypi]\n repository = https://upload.pypi.org/legacy/\n username = __token__\n password = pypi-xxx-xxx\n[testpypi]\n repository = https://test.pypi.org/legacy/\n username = __token__\n password = pypi-xxx-xxx\n```\n\nTo publish zrb-extras, you can do the following command:\n\n```bash\nzrb project publish-zrb-extras\n```\n\n## Updating version\n\nYou can update zrb-extras version by modifying the following section in `pyproject.toml`:\n\n```toml\n[project]\nversion = \"0.0.2\"\n```\n\n## Adding dependencies\n\nTo add zrb-extras dependencies, you can edit the following section in `pyproject.toml`:\n\n```toml\n[project]\ndependencies = [\n \"Jinja2==3.1.2\",\n \"jsons==1.6.3\"\n]\n```\n\n## Adding script\n\nTo make zrb-extras executable, you can edit the following section in `pyproject.toml`:\n\n```toml\n[project-scripts]\nzrb-extras-hello = \"zrb_extras.__main__:hello\"\n```\n\nNow, whenever you run `zrb-extras-hello`, the `main` function on your `__main__.py` will be executed.\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "Collection of Zrb additional utilities",
"version": "0.0.6",
"project_urls": {
"Documentation": "https://github.com/goFrendiAsgard/zrb-extras",
"Homepage": "https://github.com/goFrendiAsgard/zrb-extras",
"Repository": "https://github.com/goFrendiAsgard/zrb-extras"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c15231de8d55c32c5106333bccd8515695d04de76cff8c6f32d2a4a7acb0747",
"md5": "dff785e1b3c42b74954da4a0a7357b6d",
"sha256": "d1711214cbb6600f1d87e9af18cf2d3c60cc8c1ddc2da5139df300639153ef10"
},
"downloads": -1,
"filename": "zrb_extras-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dff785e1b3c42b74954da4a0a7357b6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.10.0",
"size": 377837,
"upload_time": "2024-08-11T12:33:49",
"upload_time_iso_8601": "2024-08-11T12:33:49.676188Z",
"url": "https://files.pythonhosted.org/packages/3c/15/231de8d55c32c5106333bccd8515695d04de76cff8c6f32d2a4a7acb0747/zrb_extras-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb962b1dce011410b97bc0bc869d5bec6e8c6aa02a7955a847af591207f19ac1",
"md5": "24414a52db5b4d20471aa376cafa958a",
"sha256": "8870e6b676f47ed9b60057f061cb38ec29718823834ef2a550e47471b66be0b7"
},
"downloads": -1,
"filename": "zrb_extras-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "24414a52db5b4d20471aa376cafa958a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.10.0",
"size": 212425,
"upload_time": "2024-08-11T12:33:53",
"upload_time_iso_8601": "2024-08-11T12:33:53.413223Z",
"url": "https://files.pythonhosted.org/packages/bb/96/2b1dce011410b97bc0bc869d5bec6e8c6aa02a7955a847af591207f19ac1/zrb_extras-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-11 12:33:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "goFrendiAsgard",
"github_project": "zrb-extras",
"github_not_found": true,
"lcname": "zrb-extras"
}
JSON
