Skip to main content

setup.cfg generator

Project description

Installation

$ [sudo] pip install setupcfg-generator

Features

[metadata] files/environment variables
name current directory basename or $NAME
classifiers classifiers.txt, $CLASSIFIERS
description description.txt, $DESCRIPTION
keywords keywords.txt, $KEYWORDS
long_description README.md/README.rst, $LONG_DESCRIPTION
long_description_content_type text/markdown if long_description is .md file
version version.txt, $VERSION
url $URL
[options] files/environment variables
install_requires requirements.txt
packages setuptools.find_packages()result, folders with __init__.py
py_modules python files in a current directory
scripts bin/* or scripts/* files

files can be in the current directory or any subdirectory

Functions

function __doc__
setupcfg_generator.create(path='setup.cfg') create setup.cfg

Executable modules

usage __doc__
python -m setupcfg_generator [path] create setup.cfg

Examples

project-name.py/
├── bin
|   └── script
├── classifiers.txt
├── description.txt
├── subfolder/keywords.txt
├── requirements.txt
├── module.py
├── package
|   └── __init__.py
├── README.md
├── scripts
|   └── script
├── setup.py
├── subfolder/version.txt
$ cd path/to/project-name.py
$ export URL="https://github.com/owner/repo"
$ python -m setupcfg_generator
$ cat setup.cfg
[metadata]
name = project-name
version = 1.0.0
url = https://github.com/owner/repo
classifiers = file: classifiers.txt
description = file: description.txt
long_description = file: README.md
long_description_content_type = text/markdown
keywords = key1 key2

[options]
install_requires =
    req1
    req2
packages =
    pkgname
py_modules =
    module
scripts =
    bin/script
    scripts/script

Related projects

python-readme-generator

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for setupcfg-generator, version 2019.4.13
Filename, size File type Python version Upload date Hashes
Filename, size setupcfg-generator-2019.4.13.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page