| Name | petrus JSON |
| Version |
0.4.62
JSON |
| download |
| home_page | None |
| Summary | Create/autocomplete/format a python project and upload it to PyPI. |
| upload_time | 2025-02-09 13:47:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | The MIT License (MIT)
Copyright (c) 2024 Johannes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
======
petrus
======
Overview
--------
Create/autocomplete/format a python project and upload it to PyPI.
Installation
------------
To install ``petrus``, you can use ``pip``. Open your terminal and run:
.. code-block:: bash
pip install petrus
Usage
-----
The ``petrus`` package provides the functions ``main`` and ``run``. ``main`` provides the CLI. To familiarize us with ``petrus`` it may be a good starting point to use the help option of main:
.. code-block:: bash
# bash
python3 -m petrus -h
or
.. code-block:: python
# python
import petrus
petrus.main(["-h"])
The arguments of ``main`` can also be used analogously on the function ``run`` (except for the flags ``-h`` and ``-V``).
.. code-block:: python
# The following lines are all identical:
petrus.main(["--author", "John Doe", "path/to/project"])
petrus.main(["--author=John Doe", "path/to/project"])
petrus.main(["--author", "John Doe", "--", "path/to/project"])
petrus.run("path/to/project", author="John Doe")
petrus.run(author="John Doe", path="path/to/project")
petrus.run("path/to/project", author="John Doe", email=None)
If an option is not used (i.e. given the value ``None``) it defaults to the value provided in the ``default`` table in the included file ``config.toml`` (if existent).
.. code-block:: toml
[default]
author = "Johannes"
description = ""
email = "johannes-programming@mailfence.com"
github = "johannes-programming"
requires_python = "{preset} \\| {current}"
v = "bump(2, 1)"
year = "{current}"
[general]
root = ""
If that fails the arguments default to the empty string. The empty string itself usually results in skipping whatever steps required the information.
The ``general.root`` setting allows to change directory even before ``path`` is applied.
It is recommended to create a ``config.toml`` file inside the ``petrus`` package before usage.
License
-------
This project is licensed under the MIT License.
Links
-----
* `Download <https://pypi.org/project/petrus/#files>`_
* `Index <https://pypi.org/project/petrus>`_
* `Source <https://github.com/johannes-programming/petrus>`_
* `Website <http://www.petrus.johannes-programming.online>`_
Credits
-------
* Author: `Johannes <http://www.johannes-programming.online>`_
* Email: `johannes-programming@mailfence.com <mailto:johannes-programming@mailfence.com>`_
Thank you for using ``petrus``!
Raw data
{
"_id": null,
"home_page": null,
"name": "petrus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Johannes <johannes-programming@mailfence.com>",
"download_url": "https://files.pythonhosted.org/packages/20/cd/a0183fc83cf5311f8eb989c7cce4e61dd4d8dc0e0892fa1e4637950a9219/petrus-0.4.62.tar.gz",
"platform": null,
"description": "======\npetrus\n======\n\nOverview\n--------\n\nCreate/autocomplete/format a python project and upload it to PyPI.\n\nInstallation\n------------\n\nTo install ``petrus``, you can use ``pip``. Open your terminal and run:\n\n.. code-block:: bash\n\n pip install petrus\n\nUsage\n-----\n\nThe ``petrus`` package provides the functions ``main`` and ``run``. ``main`` provides the CLI. To familiarize us with ``petrus`` it may be a good starting point to use the help option of main:\n\n.. code-block:: bash\n\n # bash\n python3 -m petrus -h\n\nor\n\n.. code-block:: python\n\n # python\n import petrus\n petrus.main([\"-h\"])\n\nThe arguments of ``main`` can also be used analogously on the function ``run`` (except for the flags ``-h`` and ``-V``).\n\n.. code-block:: python\n\n # The following lines are all identical:\n petrus.main([\"--author\", \"John Doe\", \"path/to/project\"])\n petrus.main([\"--author=John Doe\", \"path/to/project\"])\n petrus.main([\"--author\", \"John Doe\", \"--\", \"path/to/project\"])\n petrus.run(\"path/to/project\", author=\"John Doe\")\n petrus.run(author=\"John Doe\", path=\"path/to/project\")\n petrus.run(\"path/to/project\", author=\"John Doe\", email=None)\n\nIf an option is not used (i.e. given the value ``None``) it defaults to the value provided in the ``default`` table in the included file ``config.toml`` (if existent).\n\n.. code-block:: toml\n\n [default]\n author = \"Johannes\"\n description = \"\"\n email = \"johannes-programming@mailfence.com\"\n github = \"johannes-programming\"\n requires_python = \"{preset} \\\\| {current}\"\n v = \"bump(2, 1)\"\n year = \"{current}\"\n\n [general]\n root = \"\"\n\nIf that fails the arguments default to the empty string. The empty string itself usually results in skipping whatever steps required the information.\nThe ``general.root`` setting allows to change directory even before ``path`` is applied.\nIt is recommended to create a ``config.toml`` file inside the ``petrus`` package before usage.\n\nLicense\n-------\n\nThis project is licensed under the MIT License.\n\nLinks\n-----\n\n* `Download <https://pypi.org/project/petrus/#files>`_\n* `Index <https://pypi.org/project/petrus>`_\n* `Source <https://github.com/johannes-programming/petrus>`_\n* `Website <http://www.petrus.johannes-programming.online>`_\n\nCredits\n-------\n\n* Author: `Johannes <http://www.johannes-programming.online>`_\n* Email: `johannes-programming@mailfence.com <mailto:johannes-programming@mailfence.com>`_\n\nThank you for using ``petrus``!\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)\n \n Copyright (c) 2024 Johannes\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Create/autocomplete/format a python project and upload it to PyPI.",
"version": "0.4.62",
"project_urls": {
"Documentation": "https://pypi.org/project/petrus",
"Download": "https://pypi.org/project/petrus/#files",
"Index": "https://pypi.org/project/petrus",
"Source": "https://github.com/johannes-programming/petrus",
"Website": "http://www.petrus.johannes-programming.online"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "498bd7da554fccc9395fc479e37beb32ea15136ea266d8fddc390ee45bd48e2b",
"md5": "5ab454f64c3adeca4f3304d6c9c35a0d",
"sha256": "fb490d01f361af46cef281ddc2dfbf5736b40d2ad0514ecdee2198a9a3199fc3"
},
"downloads": -1,
"filename": "petrus-0.4.62-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ab454f64c3adeca4f3304d6c9c35a0d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 19878,
"upload_time": "2025-02-09T13:47:53",
"upload_time_iso_8601": "2025-02-09T13:47:53.543528Z",
"url": "https://files.pythonhosted.org/packages/49/8b/d7da554fccc9395fc479e37beb32ea15136ea266d8fddc390ee45bd48e2b/petrus-0.4.62-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "20cda0183fc83cf5311f8eb989c7cce4e61dd4d8dc0e0892fa1e4637950a9219",
"md5": "5f0798156a2fbe0028387084c15e79e4",
"sha256": "3c8a0593f2de8452900dc658c45a9b10d858f5368ecf4847ee0dae2a4785ac6c"
},
"downloads": -1,
"filename": "petrus-0.4.62.tar.gz",
"has_sig": false,
"md5_digest": "5f0798156a2fbe0028387084c15e79e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15874,
"upload_time": "2025-02-09T13:47:57",
"upload_time_iso_8601": "2025-02-09T13:47:57.458696Z",
"url": "https://files.pythonhosted.org/packages/20/cd/a0183fc83cf5311f8eb989c7cce4e61dd4d8dc0e0892fa1e4637950a9219/petrus-0.4.62.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-09 13:47:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "johannes-programming",
"github_project": "petrus",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "petrus"
}
