Simple module to generate setup.py template.
Project description
SetupPY
SetupPY is the utility to generate a simple setup.py file (template) with useful comments and links.
Features
Generates setup.py file with the following content:
- automatically fulfilled package name based on the name of the current directory.
- some basic fields to fulfill.
- clarifying comments and links to useful resources.
- automatically inserted description from README.md or an empty string if there is no README.md.
Installation
sudo pip install setup-py-cli
Usage
To generate setup.py file just type in the terminal.
setup-py
Now setup.py file should occur in the current directory.
Generated setup.py file
from distutils.core import setup
from setuptools import find_packages
import os
# User-friendly description from README.md
current_directory = os.path.dirname(os.path.abspath(__file__))
try:
with open(os.path.join(current_directory, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
except Exception:
long_description = ''
setup(
# Name of the package
name='setup_py',
# Packages to include into the distribution
packages=find_packages(','),
# Start with a small number and increase it with
# every change you make https://semver.org
version='1.0.0',
# Chose a license from here: https: //
# help.github.com / articles / licensing - a -
# repository. For example: MIT
license='',
# Short description of your library
description='',
# Long description of your library
long_description=long_description,
long_description_content_type='text/markdown',
# Your name
author='',
# Your email
author_email='',
# Either the link to your github or to your website
url='',
# Link from which the project can be downloaded
download_url='',
# List of keywords
keywords=[],
# List of packages to install with this one
install_requires=[],
# https://pypi.org/classifiers/
classifiers=[]
)
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Ilya Vouk - Initial work - voilalex
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file setup-py-cli-2.1.0.tar.gz
.
File metadata
- Download URL: setup-py-cli-2.1.0.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fffb019d96f437e55d997918887d691bb2c0d269bf147de9325421c69e6ceb44 |
|
MD5 | 06bd69a20eb6fe9b65ad8a870a6e74c6 |
|
BLAKE2b-256 | 20d7896c0a61a6eb2483b5ab6ec4711dc2bfb21d7a178e7303065f2c1a5b1388 |