======
pkglts
======
.. {# pkglts, doc
.. image:: https://ci.appveyor.com/api/projects/status/hrwjhn2oe0q4oaf2/branch/master?svg=true
:alt: Appveyor build status
:target: https://ci.appveyor.com/project/revesansparole/pkglts/branch/master
.. image:: https://coveralls.io/repos/github/revesansparole/pkglts/badge.svg?branch=master
:alt: Coverage report status
:target: https://coveralls.io/github/revesansparole/pkglts?branch=master
.. image:: https://landscape.io/github/revesansparole/pkglts/master/landscape.svg?style=flat
:alt: Code health status
:target: https://landscape.io/github/revesansparole/pkglts/master
.. image:: https://img.shields.io/lgtm/grade/python/g/revesansparole/pkglts.svg?logo=lgtm&logoWidth=18
:alt: Language grade: Python
:target: https://lgtm.com/projects/g/revesansparole/pkglts/context:python
.. image:: https://badge.fury.io/py/pkglts.svg
:alt: PyPI version
:target: https://badge.fury.io/py/pkglts
.. image:: https://readthedocs.org/projects/pkglts/badge/?version=latest
:alt: Documentation status
:target: https://pkglts.readthedocs.io/en/latest/?badge=latest
.. image:: https://requires.io/github/revesansparole/pkglts/requirements.svg?branch=master
:alt: Requirements status
:target: https://requires.io/github/revesansparole/pkglts/requirements/?branch=master
.. image:: https://api.travis-ci.com/revesansparole/pkglts.svg?branch=master
:alt: Travis build status
:target: https://travis-ci.com/github/revesansparole/pkglts
.. #}
.. image:: https://anaconda.org/revesansparole/pkglts/badges/version.svg
:alt: Anaconda version
:target: https://anaconda.org/revesansparole/pkglts
Building packages with long term support
.. image:: https://raw.githubusercontent.com/revesansparole/pkglts/master/avatar.png
:align: right
:width: 256px
The rationale behind the creation of this 'package builder' is to keep the life
of a python programmer as easy as possible by providing three core functions:
- A way to add more functionality to an existing package.
- A way to keep the package structure up to date with currently known best
practices.
- Remove repetitive tasks that can be automated from the list of things to do.
.. _Python: http://python.org
Quick start
===========
Create a virtual environment for development::
$ virtualenv dvlpt
Activate it::
$ (on windows)dvlpt\Scripts\activate
$ (on linux)dvlpt/bin/activate
Install pkglts_::
(dvlpt)$ pip install pkglts
Create a directory for your package::
(dvlpt)$ mkdir toto
Run 'manage' inside this directory::
(dvlpt)$ cd toto
(dvlpt)toto$ pmg init
(dvlpt)toto$ pmg add base
(dvlpt)toto$ pmg regenerate
This will create the bare basic minimum for a python package. Add more options
(see the add_option_ for more options) afterward. Especially, since in the example
above we just added the 'base' option that will create a 'src' directory to put
your code in it.
.. _pkglts: https://pypi.python.org/pypi/pkglts/
.. _add_option: https://pkglts.readthedocs.org/en/latest/option_list.html
Documentation
=============
More documentation can be found on readthedocs_pkglts_. If you just intend to use this package
you can start with some tutorials_. However, if the core functionality are
not sufficient and you want to be part of the development you might be interested
with the developer_ section of the doc.
.. _readthedocs_pkglts: https://pkglts.readthedocs.org/en/latest
.. _tutorials: https://pkglts.readthedocs.org/en/latest/tutorials.html
.. _developer: https://pkglts.readthedocs.org/en/latest
Raw data
{
"_id": null,
"home_page": null,
"name": "pkglts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "revesansparole <revesansparole@gmail.com>, ThT12 <ThT12@ThT12.fr>, pradal <christophe.pradal@inria.fr>, egarciaitk <emilien.garcia@itk.fr>, Simon Artzet <simon.artzet@gmail.com>, lquibel <lucie.quibel@itk.fr>, Christophe Pradal <christophe.pradal@inria.fr>, Samuel Andres <samuel.andres@itk.fr>",
"keywords": "packaging, package builder",
"author": null,
"author_email": "revesansparole <revesansparole@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/eb/1c258988a502f41fcff2527565104d2558170de26828c8a515709d09f795/pkglts-7.7.0.tar.gz",
"platform": null,
"description": "======\r\npkglts\r\n======\r\n\r\n.. {# pkglts, doc\r\n\r\n.. image:: https://ci.appveyor.com/api/projects/status/hrwjhn2oe0q4oaf2/branch/master?svg=true\r\n :alt: Appveyor build status\r\n :target: https://ci.appveyor.com/project/revesansparole/pkglts/branch/master\r\n\r\n.. image:: https://coveralls.io/repos/github/revesansparole/pkglts/badge.svg?branch=master\r\n :alt: Coverage report status\r\n :target: https://coveralls.io/github/revesansparole/pkglts?branch=master\r\n\r\n.. image:: https://landscape.io/github/revesansparole/pkglts/master/landscape.svg?style=flat\r\n :alt: Code health status\r\n :target: https://landscape.io/github/revesansparole/pkglts/master\r\n\r\n.. image:: https://img.shields.io/lgtm/grade/python/g/revesansparole/pkglts.svg?logo=lgtm&logoWidth=18\r\n :alt: Language grade: Python\r\n :target: https://lgtm.com/projects/g/revesansparole/pkglts/context:python\r\n\r\n.. image:: https://badge.fury.io/py/pkglts.svg\r\n :alt: PyPI version\r\n :target: https://badge.fury.io/py/pkglts\r\n\r\n.. image:: https://readthedocs.org/projects/pkglts/badge/?version=latest\r\n :alt: Documentation status\r\n :target: https://pkglts.readthedocs.io/en/latest/?badge=latest\r\n\r\n.. image:: https://requires.io/github/revesansparole/pkglts/requirements.svg?branch=master\r\n :alt: Requirements status\r\n :target: https://requires.io/github/revesansparole/pkglts/requirements/?branch=master\r\n\r\n.. image:: https://api.travis-ci.com/revesansparole/pkglts.svg?branch=master\r\n :alt: Travis build status\r\n :target: https://travis-ci.com/github/revesansparole/pkglts\r\n\r\n.. #}\r\n\r\n.. image:: https://anaconda.org/revesansparole/pkglts/badges/version.svg\r\n :alt: Anaconda version\r\n :target: https://anaconda.org/revesansparole/pkglts\r\n\r\nBuilding packages with long term support\r\n\r\n\r\n.. image:: https://raw.githubusercontent.com/revesansparole/pkglts/master/avatar.png\r\n :align: right\r\n :width: 256px\r\n\r\nThe rationale behind the creation of this 'package builder' is to keep the life\r\nof a python programmer as easy as possible by providing three core functions:\r\n\r\n - A way to add more functionality to an existing package.\r\n - A way to keep the package structure up to date with currently known best\r\n practices.\r\n - Remove repetitive tasks that can be automated from the list of things to do.\r\n\r\n.. _Python: http://python.org\r\n\r\nQuick start\r\n===========\r\n\r\nCreate a virtual environment for development::\r\n\r\n $ virtualenv dvlpt\r\n\r\nActivate it::\r\n\r\n $ (on windows)dvlpt\\Scripts\\activate\r\n $ (on linux)dvlpt/bin/activate\r\n\r\nInstall pkglts_::\r\n\r\n (dvlpt)$ pip install pkglts\r\n\r\nCreate a directory for your package::\r\n\r\n (dvlpt)$ mkdir toto\r\n\r\nRun 'manage' inside this directory::\r\n\r\n (dvlpt)$ cd toto\r\n (dvlpt)toto$ pmg init\r\n (dvlpt)toto$ pmg add base\r\n (dvlpt)toto$ pmg regenerate\r\n\r\nThis will create the bare basic minimum for a python package. Add more options\r\n(see the add_option_ for more options) afterward. Especially, since in the example\r\nabove we just added the 'base' option that will create a 'src' directory to put\r\nyour code in it.\r\n\r\n.. _pkglts: https://pypi.python.org/pypi/pkglts/\r\n.. _add_option: https://pkglts.readthedocs.org/en/latest/option_list.html\r\n\r\nDocumentation\r\n=============\r\n\r\nMore documentation can be found on readthedocs_pkglts_. If you just intend to use this package\r\nyou can start with some tutorials_. However, if the core functionality are\r\nnot sufficient and you want to be part of the development you might be interested\r\nwith the developer_ section of the doc.\r\n\r\n\r\n.. _readthedocs_pkglts: https://pkglts.readthedocs.org/en/latest\r\n.. _tutorials: https://pkglts.readthedocs.org/en/latest/tutorials.html\r\n.. _developer: https://pkglts.readthedocs.org/en/latest\r\n",
"bugtrack_url": null,
"license": "CeCILL-C",
"summary": "Building packages with long term support",
"version": "7.7.0",
"project_urls": {
"appveyor": "https://ci.appveyor.com/project/revesansparole/pkglts/branch/master",
"coveralls": "https://coveralls.io/github/revesansparole/pkglts?branch=master",
"landscape": "https://landscape.io/github/revesansparole/pkglts/master",
"lgtm": "https://lgtm.com/projects/g/revesansparole/pkglts/context:python",
"pypi": "https://badge.fury.io/py/pkglts",
"readthedocs": "https://pkglts.readthedocs.io/en/latest/?badge=latest",
"repository": "https://github.com/revesansparole/pkglts",
"requires": "https://requires.io/github/revesansparole/pkglts/requirements/?branch=master",
"travis": "https://travis-ci.com/github/revesansparole/pkglts"
},
"split_keywords": [
"packaging",
" package builder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea68924df38c5a6236ecd83cecda4fc7844b70859a75d47a490b2034e678ed92",
"md5": "75ae3a4127190be9f2e9f2f401730653",
"sha256": "9b47c5fdca5e83ca0524f325b5eaf8e6cf644ef6886bcc826a517fdf8d1f6409"
},
"downloads": -1,
"filename": "pkglts-7.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "75ae3a4127190be9f2e9f2f401730653",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1620018,
"upload_time": "2024-08-12T07:56:53",
"upload_time_iso_8601": "2024-08-12T07:56:53.120932Z",
"url": "https://files.pythonhosted.org/packages/ea/68/924df38c5a6236ecd83cecda4fc7844b70859a75d47a490b2034e678ed92/pkglts-7.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6feb1c258988a502f41fcff2527565104d2558170de26828c8a515709d09f795",
"md5": "09144a6f39ce34de132ac19b2910b864",
"sha256": "35483b259212a83a26c9e2e20636aeac52c9586f6dcfa56bb6069e5eb08f7d38"
},
"downloads": -1,
"filename": "pkglts-7.7.0.tar.gz",
"has_sig": false,
"md5_digest": "09144a6f39ce34de132ac19b2910b864",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1579268,
"upload_time": "2024-08-12T07:56:57",
"upload_time_iso_8601": "2024-08-12T07:56:57.375016Z",
"url": "https://files.pythonhosted.org/packages/6f/eb/1c258988a502f41fcff2527565104d2558170de26828c8a515709d09f795/pkglts-7.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 07:56:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "revesansparole",
"github_project": "pkglts",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"landscape": true,
"appveyor": true,
"requirements": [
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx-rtd-theme",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "twine",
"specs": []
},
{
"name": "jinja2",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "semver",
"specs": []
},
{
"name": "unidecode",
"specs": []
},
{
"name": "url-normalize",
"specs": []
},
{
"name": "coverage",
"specs": []
},
{
"name": "coveralls",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "pytest-mock",
"specs": []
},
{
"name": "tox",
"specs": []
}
],
"tox": true,
"lcname": "pkglts"
}
JSON
