# `setupextras` [](https://badge.fury.io/py/setupextras) [](https://travis-ci.com/grimen/python-setupextras) [](https://codecov.io/gh/grimen/python-setupextras)
*Additional common `setuptools` helpers - for Python.*
## Introduction
TODO
## Install
Install using **pip**:
```sh
$ pip install setupextras
```
## Use
Very basic **[example](https://github.com/grimen/python-setupextras/tree/master/examples/basic.py)**:
```python
# =========================================
# IMPORTS
# --------------------------------------
import os
import json
import setuptools
import setupextras
# =========================================
# PACKAGE
# --------------------------------------
name = 'foo'
version = '1.0.0'
description = 'A foo library.'
keywords = [
'foo',
'bar',
]
packages = setupextras.get_packages()
data_files = setupextras.get_data_files(['*.*'], os.path.join(name, 'tests', '__fixtures__'))
requirements = setupextras.get_requirements()
readme = setupextras.get_readme()
config = {
'name': name,
'version': version,
'description': (description),
'keywords': keywords,
'author': 'Jonas Grimfelt',
'author_email': 'grimen@gmail.com',
'url': 'https://github.com/grimen/python-{name}'.format(name = name),
'download_url': 'https://github.com/grimen/python-{name}'.format(name = name),
'project_urls': {
'repository': 'https://github.com/grimen/python-{name}'.format(name = name),
'bugs': 'https://github.com/grimen/python-{name}/issues'.format(name = name),
},
'license': 'MIT',
'long_description': readme,
'packages': packages,
'data_files': data_files,
'install_requires': requirements,
}
print('CONFIG {0}'.format(json.dumps(config, indent = 4)))
# =========================================
# MAIN
# --------------------------------------
setuptools.setup(**config)
```
## Test
Clone down source code:
```sh
$ make install
```
Run **colorful tests**, with only native environment (dependency sandboxing up to you):
```sh
$ make test
```
Run **less colorful tests**, with **multi-environment** (using **tox**):
```sh
$ make test-tox
```
## About
This project was mainly initiated - in lack of solid existing alternatives - to be used at our work at **[Markable.ai](https://markable.ai)** to have common code conventions between various programming environments where **Python** (research, CV, AI) is heavily used.
## License
Released under the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/grimen/python-setupextras",
"name": "setupextras",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "setup,setuptools,extras,helpers,tools,package,utils,config,packages,data-files,requirements,readme,pip,pypi",
"author": "Jonas Grimfelt",
"author_email": "grimen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2b/fc/e84b4f4ef49f669585ea8682899eead0406a688bf4d12d86c4da93d6aa8d/setupextras-0.1.5.tar.gz",
"platform": "",
"description": "\n# `setupextras` [](https://badge.fury.io/py/setupextras) [](https://travis-ci.com/grimen/python-setupextras) [](https://codecov.io/gh/grimen/python-setupextras)\n\n*Additional common `setuptools` helpers - for Python.*\n\n## Introduction\n\nTODO\n\n\n## Install\n\nInstall using **pip**:\n\n```sh\n$ pip install setupextras\n```\n\n\n## Use\n\nVery basic **[example](https://github.com/grimen/python-setupextras/tree/master/examples/basic.py)**:\n\n```python\n# =========================================\n# IMPORTS\n# --------------------------------------\n\nimport os\nimport json\nimport setuptools\n\nimport setupextras\n\n\n# =========================================\n# PACKAGE\n# --------------------------------------\n\nname = 'foo'\nversion = '1.0.0'\ndescription = 'A foo library.'\nkeywords = [\n 'foo',\n 'bar',\n]\n\npackages = setupextras.get_packages()\ndata_files = setupextras.get_data_files(['*.*'], os.path.join(name, 'tests', '__fixtures__'))\nrequirements = setupextras.get_requirements()\nreadme = setupextras.get_readme()\n\nconfig = {\n 'name': name,\n 'version': version,\n 'description': (description),\n 'keywords': keywords,\n 'author': 'Jonas Grimfelt',\n 'author_email': 'grimen@gmail.com',\n 'url': 'https://github.com/grimen/python-{name}'.format(name = name),\n 'download_url': 'https://github.com/grimen/python-{name}'.format(name = name),\n 'project_urls': {\n 'repository': 'https://github.com/grimen/python-{name}'.format(name = name),\n 'bugs': 'https://github.com/grimen/python-{name}/issues'.format(name = name),\n },\n 'license': 'MIT',\n 'long_description': readme,\n 'packages': packages,\n 'data_files': data_files,\n 'install_requires': requirements,\n}\n\nprint('CONFIG {0}'.format(json.dumps(config, indent = 4)))\n\n\n# =========================================\n# MAIN\n# --------------------------------------\n\nsetuptools.setup(**config)\n```\n\n\n## Test\n\nClone down source code:\n\n```sh\n$ make install\n```\n\nRun **colorful tests**, with only native environment (dependency sandboxing up to you):\n\n```sh\n$ make test\n```\n\nRun **less colorful tests**, with **multi-environment** (using **tox**):\n\n```sh\n$ make test-tox\n```\n\n\n## About\n\nThis project was mainly initiated - in lack of solid existing alternatives - to be used at our work at **[Markable.ai](https://markable.ai)** to have common code conventions between various programming environments where **Python** (research, CV, AI) is heavily used.\n\n\n## License\n\nReleased under the MIT license.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Additional common `setuptools` helpers - for Python.",
"version": "0.1.5",
"split_keywords": [
"setup",
"setuptools",
"extras",
"helpers",
"tools",
"package",
"utils",
"config",
"packages",
"data-files",
"requirements",
"readme",
"pip",
"pypi"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b60970b10847a334e422b0b2eccb1a07",
"sha256": "b065860551e9dd422efe35c15dd8cd7edf9ebaeb1309a7bca5475b6010f926aa"
},
"downloads": -1,
"filename": "setupextras-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b60970b10847a334e422b0b2eccb1a07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16047,
"upload_time": "2019-03-11T19:41:08",
"upload_time_iso_8601": "2019-03-11T19:41:08.252419Z",
"url": "https://files.pythonhosted.org/packages/18/2c/8ffaab19cde5c47a04554d675c0de31ad9ae8da6261dac8808e2a178f50d/setupextras-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "02306fc78d9bc55995ceeb81c9c68aca",
"sha256": "2c21d99d01fdf3340a67066fcd0a97aae3f2f24b305d6c11b196526faa91df1a"
},
"downloads": -1,
"filename": "setupextras-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "02306fc78d9bc55995ceeb81c9c68aca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13084,
"upload_time": "2019-03-11T19:41:09",
"upload_time_iso_8601": "2019-03-11T19:41:09.626431Z",
"url": "https://files.pythonhosted.org/packages/2b/fc/e84b4f4ef49f669585ea8682899eead0406a688bf4d12d86c4da93d6aa8d/setupextras-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-03-11 19:41:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "grimen",
"github_project": "python-setupextras",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "six",
"specs": [
[
">=",
"1.11.0"
]
]
},
{
"name": "rootpath",
"specs": [
[
">=",
"0.1.1"
]
]
},
{
"name": "inspecta",
"specs": [
[
">=",
"0.1.0"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"40.8.0"
]
]
},
{
"name": "colour-runner",
"specs": [
[
">=",
"0.0.5"
]
]
},
{
"name": "deepdiff",
"specs": [
[
">=",
"3.3.0"
]
]
},
{
"name": "tox",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "coverage",
"specs": [
[
">=",
"4.5.2"
]
]
},
{
"name": "codecov",
"specs": [
[
">=",
"2.0.15"
]
]
}
],
"tox": true,
"lcname": "setupextras"
}
JSON
