pqinfo
=========
*A skeleton command line program in Python.*
Purpose
-------
This is a skeleton application which demonstrates how to properly structure a
Python CLI application.
I've done my best to structure this in a way that makes sense for *most* users,
but if you have any feedback, please open a Github issue and I'll take a look.
The idea with this project is that you should be able to use this as a template
for building new CLI apps.
You can fork this project and customize it to your liking, or just use it as a
reference.
Usage
-----
If you've cloned this project, and want to install the library (*and all
development dependencies*), the command you'll want to run is::
$ pip install -e .[test]
If you'd like to run all tests for this project (*assuming you've written
some*), you would run the following command::
$ python setup.py test
This will trigger `py.test <http://pytest.org/latest/>`_, along with its popular
`coverage <https://pypi.python.org/pypi/pytest-cov>`_ plugin.
Lastly, if you'd like to cut a new release of this CLI tool, and publish it to
the Python Package Index (`PyPI <https://pypi.python.org/pypi>`_), you can do so
by running::
$ python setup.py sdist bdist_wheel
$ twine upload dist/*
This will build both a source tarball of your CLI tool, as well as a newer wheel
build (*and this will, by default, run on all platforms*).
The ``twine upload`` command (which requires you to install the `twine
<https://pypi.python.org/pypi/twine>`_ tool) will then securely upload your
new package to PyPI so everyone in the world can use it!
Raw data
{
"_id": null,
"home_page": "https://github.com/JayjeetAtGithub/pqinfo",
"name": "pqinfo",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cli",
"author": "Jayjeet Chakraborty",
"author_email": "jayjeetc@ucsc.edu",
"download_url": "https://files.pythonhosted.org/packages/05/10/b04c6193b2ed17080cdb3929af816eb29932377f5be98ad167e3fe426084/pqinfo-1.0.0.tar.gz",
"platform": null,
"description": "pqinfo\n=========\n\n*A skeleton command line program in Python.*\n\n\nPurpose\n-------\n\nThis is a skeleton application which demonstrates how to properly structure a\nPython CLI application.\n\nI've done my best to structure this in a way that makes sense for *most* users,\nbut if you have any feedback, please open a Github issue and I'll take a look.\n\nThe idea with this project is that you should be able to use this as a template\nfor building new CLI apps.\n\nYou can fork this project and customize it to your liking, or just use it as a\nreference.\n\n\nUsage\n-----\n\nIf you've cloned this project, and want to install the library (*and all\ndevelopment dependencies*), the command you'll want to run is::\n\n $ pip install -e .[test]\n\nIf you'd like to run all tests for this project (*assuming you've written\nsome*), you would run the following command::\n\n $ python setup.py test\n\nThis will trigger `py.test <http://pytest.org/latest/>`_, along with its popular\n`coverage <https://pypi.python.org/pypi/pytest-cov>`_ plugin.\n\nLastly, if you'd like to cut a new release of this CLI tool, and publish it to\nthe Python Package Index (`PyPI <https://pypi.python.org/pypi>`_), you can do so\nby running::\n\n $ python setup.py sdist bdist_wheel\n $ twine upload dist/*\n\nThis will build both a source tarball of your CLI tool, as well as a newer wheel\nbuild (*and this will, by default, run on all platforms*).\n\nThe ``twine upload`` command (which requires you to install the `twine\n<https://pypi.python.org/pypi/twine>`_ tool) will then securely upload your\nnew package to PyPI so everyone in the world can use it!\n",
"bugtrack_url": null,
"license": "UNLICENSE",
"summary": "A CLI tool to see the details of a Parquet file",
"version": "1.0.0",
"split_keywords": [
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15f8cb5b776eafc455e7aeaa441fe27ee0b4fbbb401c72093f347893ea9adb7c",
"md5": "1a52aca4f08ebdcae72181f1b0bdbde3",
"sha256": "858ac957e0c1eecc326174b68147bf3ac87b2402d137c04e175e6565e9b405a7"
},
"downloads": -1,
"filename": "pqinfo-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a52aca4f08ebdcae72181f1b0bdbde3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 4424,
"upload_time": "2023-03-12T05:12:37",
"upload_time_iso_8601": "2023-03-12T05:12:37.341241Z",
"url": "https://files.pythonhosted.org/packages/15/f8/cb5b776eafc455e7aeaa441fe27ee0b4fbbb401c72093f347893ea9adb7c/pqinfo-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0510b04c6193b2ed17080cdb3929af816eb29932377f5be98ad167e3fe426084",
"md5": "365073f6c8af7075a790cef65ea42837",
"sha256": "f9da94588fcfb6dec73ec30abc177cdd77627bb805d1612f4d338bed86c6a833"
},
"downloads": -1,
"filename": "pqinfo-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "365073f6c8af7075a790cef65ea42837",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4410,
"upload_time": "2023-03-12T05:12:40",
"upload_time_iso_8601": "2023-03-12T05:12:40.159462Z",
"url": "https://files.pythonhosted.org/packages/05/10/b04c6193b2ed17080cdb3929af816eb29932377f5be98ad167e3fe426084/pqinfo-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-12 05:12:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "JayjeetAtGithub",
"github_project": "pqinfo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pqinfo"
}
JSON
