{ "info": { "author": "Evan Sosenko", "author_email": "razorx@evansosenko.com", "bugtrack_url": null, "classifiers": [], "description": "Python Package Skeleton\n=======================\n\n|PyPI| |Codecov| |CircleCI|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/makenew-pypackage.svg\n :target: https://pypi.python.org/pypi/makenew-pypackage\n :alt: PyPI\n.. |Codecov| image:: https://img.shields.io/codecov/c/github/makenew/pypackage.svg\n :target: https://codecov.io/gh/makenew/pypackage\n :alt: Codecov\n.. |CircleCI| image:: https://img.shields.io/circleci/project/github/makenew/pypackage.svg\n :target: https://circleci.com/gh/makenew/pypackage\n :alt: CircleCI\n\nPackage skeleton for an Python module.\n\nDescription\n-----------\n\nBootstrap a new Python_ package in less than a minute.\n\n.. _Python: https://www.python.org/\n\nFeatures\n~~~~~~~~\n\n- Package management with setuptools_ and publishing to PyPI_.\n- Secure dependency management with Pipenv_.\n- Linting with Pylint_.\n- pytest_ helps you write better programs.\n- Code coverage reporting with Codecov_.\n- CircleCI_ ready.\n- `Keep a CHANGELOG`_.\n- Consistent coding with EditorConfig_.\n- Badges from Shields.io_.\n\n.. _Codecov: https://codecov.io/\n.. _EditorConfig: https://editorconfig.org/\n.. _Keep a CHANGELOG: https://keepachangelog.com/\n.. _PyPI: https://pypi.python.org/pypi\n.. _Pylint: https://www.pylint.org/\n.. _Shields.io: https://shields.io/\n.. _pytest: https://docs.pytest.org/\n.. _setuptools: https://pythonhosted.org/setuptools/.\n\nBootstrapping a New Project\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n1. Create an empty (**non-initialized**) repository on GitHub.\n2. Clone the master branch of this repository with\n\n ::\n\n $ git clone --single-branch https://github.com/makenew/pypackage.git new-pypackage\n $ cd new-pypackage\n\n Optionally, reset to the latest\n `release `__ with\n\n ::\n\n $ git reset --hard v1.2.0\n\n3. Run\n\n ::\n\n $ ./makenew.sh\n\n This will replace the boilerplate, delete itself,\n remove the git remote, remove upstream tags,\n and stage changes for commit.\n\n4. Create the required CircleCI environment variables with\n\n ::\n\n $ .circleci/envvars.sh\n\n5. Review, commit, and push the changes to GitHub with\n\n ::\n\n $ git diff --cached\n $ git commit -m \"Replace makenew boilerplate\"\n $ git remote add origin git@github.com:/.git\n $ git push -u origin master\n\n6. Ensure the CircleCI build passes,\n then publish the initial version of the package with\n\n ::\n\n $ pipenv install --dev\n $ pipenv run bumpversion patch\n $ git push\n $ git push --tags\n\nUpdating\n~~~~~~~~\n\nIf you want to pull in future updates from this skeleton,\nyou can fetch and merge in changes from this repository.\n\nAdd this as a new remote with\n\n::\n\n $ git remote rename origin upstream\n\nand then configure your ``origin`` branch as normal.\n\nOtherwise, add this as a new remote with\n\n::\n\n $ git remote add upstream git@github.com:makenew/pypackage.git\n\nYou can then fetch and merge changes with\n\n::\n\n $ git fetch --no-tags upstream\n $ git merge upstream/master\n\nChangelog\n^^^^^^^^^\n\nNote that ``CHANGELOG.md`` is just a template for this skeleton. The\nactual changes for this project are documented in the commit history and\nsummarized under\n`Releases `__.\n\nInstallation\n------------\n\nThis package is registered on the `Python Package Index (PyPI)`_\nas makenew_pypackage_.\n\nInstall it with\n\n::\n\n $ pipenv install makenew_pypackage\n\nIf you are writing a Python package which will depend on this,\nadd this to your requirements in ``setup.py``.\n\n.. _makenew_pypackage: https://pypi.python.org/pypi/makenew-pypackage\n.. _Python Package Index (PyPI): https://pypi.python.org/\n\nDevelopment and Testing\n-----------------------\n\nQuickstart\n~~~~~~~~~~\n\n::\n\n $ git clone https://github.com/makenew/pypackage.git\n $ cd pypackage\n $ pipenv install --dev\n\nRun each command below in a separate terminal window:\n\n::\n\n $ make watch\n\nPrimary development tasks are defined in the `Makefile`.\n\nSource Code\n~~~~~~~~~~~\n\nThe `source code_` is hosted on GitHub.\nClone the project with\n\n::\n\n $ git clone https://github.com/makenew/pypackage.git\n\n.. _source_code: https://github.com/makenew/pypackage\n\nRequirements\n~~~~~~~~~~~~\n\nYou will need `Python 3`_ with Pipenv_.\n\nInstall the development dependencies with\n\n::\n\n $ pipenv install --dev\n\n.. _Pipenv: https://pipenv.readthedocs.io/\n.. _Python 3: https://www.python.org/\n\nTests\n~~~~~\n\nLint code with\n\n::\n\n $ make lint\n\n\nRun tests with\n\n::\n\n $ make test\n\nRun tests on chages with\n\n::\n\n $ make watch\n\nPublishing\n~~~~~~~~~~\n\nUse the bumpversion_ command to release a new version.\nPush the created git tag which will trigger a CircleCI publish job.\n\n.. _bumpversion: https://github.com/peritus/bumpversion\n\nCircleCI Setup\n--------------\n\n*CircleCI should already be configured: this section is for reference only.*\n\nThe following environment variables must be set on CircleCI_:\n\n- ``TWINE_USERNAME``: Username for publishing on PyPI.\n- ``TWINE_PASSWORD``: Password for publishing on PyPI.\n- ``CODECOV_TOKEN``: Codecov token for uploading coverage reports (optional).\n\nThese may be set manually or by running the script ``./circleci/envvars.sh``.\n\n.. _CircleCI: https://circleci.com/\n\nContributing\n------------\n\nPlease submit and comment on bug reports and feature requests.\n\nTo submit a patch:\n\n1. Fork it (https://github.com/makenew/pypackage/fork).\n2. Create your feature branch (`git checkout -b my-new-feature`).\n3. Make changes.\n4. Commit your changes (`git commit -am 'Add some feature'`).\n5. Push to the branch (`git push origin my-new-feature`).\n6. Create a new Pull Request.\n\nLicense\n-------\n\nThis Python package is licensed under the MIT license.\n\nWarranty\n--------\n\nThis software is provided by the copyright holders and contributors \"as is\" and\nany express or implied warranties, including, but not limited to, the implied\nwarranties of merchantability and fitness for a particular purpose are\ndisclaimed. In no event shall the copyright holder or contributors be liable for\nany direct, indirect, incidental, special, exemplary, or consequential damages\n(including, but not limited to, procurement of substitute goods or services;\nloss of use, data, or profits; or business interruption) however caused and on\nany theory of liability, whether in contract, strict liability, or tort\n(including negligence or otherwise) arising in any way out of the use of this\nsoftware, even if advised of the possibility of such damage.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/makenew/pypackage", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "makenew-pypackage", "package_url": "https://pypi.org/project/makenew-pypackage/", "platform": "", "project_url": "https://pypi.org/project/makenew-pypackage/", "project_urls": { "Homepage": "https://github.com/makenew/pypackage" }, "release_url": "https://pypi.org/project/makenew-pypackage/1.0.3/", "requires_dist": null, "requires_python": "", "summary": "Package skeleton for a python module.", "version": "1.0.3" }, "last_serial": 4604052, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "9910d8c63818c70d1c75ca0cf577815d", "sha256": "c027144a36b2179a953327ddc7a53b4a290d4432515ebd1dc917fd6ae2b39c62" }, "downloads": -1, "filename": "makenew_pypackage-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "9910d8c63818c70d1c75ca0cf577815d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5204, "upload_time": "2018-12-16T00:45:49", "url": "https://files.pythonhosted.org/packages/59/30/23700759752771698e42af326ca647cf4b8f7ff8293f502566b974cb6913/makenew_pypackage-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f2e54235c02af59b853ec2495db685bf", "sha256": "4f4ca3e20e8fc3a40159090bed976364bdf43645e46ceab6a63413f4e266d141" }, "downloads": -1, "filename": "makenew-pypackage-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f2e54235c02af59b853ec2495db685bf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4559, "upload_time": "2018-12-16T00:45:51", "url": "https://files.pythonhosted.org/packages/be/67/27edbe529b3346ebaec43b65a1bc33912754cedb8572d339eab6174d1e74/makenew-pypackage-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "74eae48985421a01e9748b150c79c4a5", "sha256": "4812866b3d9534250b1f29b2459e355e10c9cb52d83ef2e39b8489fcbcebbc9f" }, "downloads": -1, "filename": "makenew_pypackage-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "74eae48985421a01e9748b150c79c4a5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5204, "upload_time": "2018-12-16T00:54:45", "url": "https://files.pythonhosted.org/packages/d3/b8/5a1fd6e4b783618c09607b6a770dbd2f2741463e401240332266e4c30e45/makenew_pypackage-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bbe6ed77b1f3b49e11ee7da685dcd55f", "sha256": "19755b00e92bd1908b8f7437fbb40d768570247c3820bfee1be6f6a771a02e25" }, "downloads": -1, "filename": "makenew-pypackage-1.0.1.tar.gz", "has_sig": false, "md5_digest": "bbe6ed77b1f3b49e11ee7da685dcd55f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4559, "upload_time": "2018-12-16T00:54:46", "url": "https://files.pythonhosted.org/packages/c7/0b/3974c602a3650b3bb32aed8ef2b6c466c0fb944d14832aa989cd04f3400d/makenew-pypackage-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "e0a7a728fb45ee6c08541bd050212566", "sha256": "c633045d19ecc75e37506438b5ed80ba9fe8ed0edb2fd3b49ea7cb2eddd22373" }, "downloads": -1, "filename": "makenew_pypackage-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "e0a7a728fb45ee6c08541bd050212566", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5201, "upload_time": "2018-12-16T00:58:22", "url": "https://files.pythonhosted.org/packages/4f/f5/c3ca4be7533745a642f73b59473b83b04477506887f34a1fb02b933d7224/makenew_pypackage-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b84827130a5e6cf7baccabacaae537fc", "sha256": "ec03f15908928d6b0cb62ec34f7d186ad5ad028d1522d5d1936101a667478664" }, "downloads": -1, "filename": "makenew-pypackage-1.0.2.tar.gz", "has_sig": false, "md5_digest": "b84827130a5e6cf7baccabacaae537fc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4558, "upload_time": "2018-12-16T00:58:24", "url": "https://files.pythonhosted.org/packages/9f/59/942c6416e591fd10c065fa44f0ef1946dc8be721bb175e9f978ca46c7a84/makenew-pypackage-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "8a2c2409eadab2630d6433654873205f", "sha256": "f9ba35a2faa22d7952823823c2f387aea57fcda1741838943dc8c783f7d4896d" }, "downloads": -1, "filename": "makenew_pypackage-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "8a2c2409eadab2630d6433654873205f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5201, "upload_time": "2018-12-16T02:21:05", "url": "https://files.pythonhosted.org/packages/cb/c2/b1f93d769d6cc3cac303b41051fcae4231442048a5612bc543ec8030140d/makenew_pypackage-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76c4d25001f140e38dbee2ecd9300837", "sha256": "ef3fde526daf2b0e0a9862f731d1372ac06d09f930c0f222087150df6c7eb3b2" }, "downloads": -1, "filename": "makenew-pypackage-1.0.3.tar.gz", "has_sig": false, "md5_digest": "76c4d25001f140e38dbee2ecd9300837", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4554, "upload_time": "2018-12-16T02:21:07", "url": "https://files.pythonhosted.org/packages/42/12/88029dffe99e5598b390f3b02d88461baba7ec1331aa22db5cf02ffae34b/makenew-pypackage-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8a2c2409eadab2630d6433654873205f", "sha256": "f9ba35a2faa22d7952823823c2f387aea57fcda1741838943dc8c783f7d4896d" }, "downloads": -1, "filename": "makenew_pypackage-1.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "8a2c2409eadab2630d6433654873205f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5201, "upload_time": "2018-12-16T02:21:05", "url": "https://files.pythonhosted.org/packages/cb/c2/b1f93d769d6cc3cac303b41051fcae4231442048a5612bc543ec8030140d/makenew_pypackage-1.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76c4d25001f140e38dbee2ecd9300837", "sha256": "ef3fde526daf2b0e0a9862f731d1372ac06d09f930c0f222087150df6c7eb3b2" }, "downloads": -1, "filename": "makenew-pypackage-1.0.3.tar.gz", "has_sig": false, "md5_digest": "76c4d25001f140e38dbee2ecd9300837", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4554, "upload_time": "2018-12-16T02:21:07", "url": "https://files.pythonhosted.org/packages/42/12/88029dffe99e5598b390f3b02d88461baba7ec1331aa22db5cf02ffae34b/makenew-pypackage-1.0.3.tar.gz" } ] }