Skip to content

Commit

Permalink
PyPI package
Browse files Browse the repository at this point in the history
  • Loading branch information
skulltech committed Jan 3, 2018
1 parent a4c1859 commit 2c1c9c0
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 20 deletions.
3 changes: 3 additions & 0 deletions MANIFEST.in
@@ -0,0 +1,3 @@
# Include the license file
include LICENSE
include README.rst
2 changes: 2 additions & 0 deletions README.md
@@ -1,6 +1,8 @@
# journalist
App to write journal digitally.

[![PyPI version](https://badge.fury.io/py/pearsend.svg)](https://badge.fury.io/py/pearsend)

## Features

- Write your journal using _Markdown_ in your favorite text-editor.
Expand Down
56 changes: 36 additions & 20 deletions setup.py
Expand Up @@ -45,7 +45,7 @@
# This is a one-line description or tagline of what your project does. This
# corresponds to the "Summary" metadata field:
# https://packaging.python.org/specifications/core-metadata/#summary
description='A sample Python project', # Required
description='App to write journal digitally', # Required

# This is an optional longer description of your project that represents
# the body of text which users will see when they visit PyPI.
Expand All @@ -61,15 +61,15 @@
#
# This field corresponds to the "Home-Page" metadata field:
# https://packaging.python.org/specifications/core-metadata/#home-page-optional
url='https://github.com/pypa/sampleproject', # Optional
url='https://github.com/SkullTech/journal', # Optional

# This should be your name or the name of the organization which owns the
# project.
author='The Python Packaging Authority', # Optional
author='Sumit Ghosh', # Optional

# This should be a valid email address corresponding to the author listed
# above.
author_email='pypa-dev@googlegroups.com', # Optional
author_email='sumit@sumit-ghosh.com', # Optional

# Classifiers help users find your project by categorizing it.
#
Expand All @@ -80,19 +80,35 @@
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
'Development Status :: 3 - Alpha',
'Development Status :: 4 - Beta',

# Environment
'Environment :: Console',
'Environment :: Web Environment',

# Framework
'Framework :: Flask',

# Indicate who your project is intended for
'Intended Audience :: Developers',
'Topic :: Software Development :: Build Tools',
'Intended Audience :: End Users/Desktop',
'Topic :: Office/Business',
'Topic :: Office/Business :: News/Diary',
'Topic :: Text Editors',
'Topic :: Text Editors :: Text Processing',
'Topic :: Text Processing :: General',
'Topic :: Text Processing :: Markup',
'Topic :: Text Processing :: Markup :: HTML',
'Topic :: Utilities',


# Pick your license as you wish
'License :: OSI Approved :: MIT License',

# Operating System
'Operating System :: OS Independent',

# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
Expand All @@ -103,7 +119,7 @@
# project page. What does your project relate to?
#
# Note that this is a string of words separated by whitespace, not a list.
keywords='sample setuptools development', # Optional
keywords='journal diary markdown html markdown-to-html', # Optional

# You can just specify package directories manually here if your project is
# simple. Or you can use find_packages().
Expand All @@ -122,7 +138,7 @@
#
# For an analysis of "install_requires" vs pip's requirements files see:
# https://packaging.python.org/en/latest/requirements.html
install_requires=['peppercorn'], # Optional
install_requires=['requests', 'flask', 'pyyaml'], # Optional

# List additional groups of dependencies here (e.g. development
# dependencies). Users will be able to install these using the "extras"
Expand All @@ -132,26 +148,26 @@
#
# Similar to `install_requires` above, these must be valid existing
# projects.
extras_require={ # Optional
'dev': ['check-manifest'],
'test': ['coverage'],
},
# extras_require={ # Optional
# 'dev': ['check-manifest'],
# 'test': ['coverage'],
# },

# If there are data files included in your packages that need to be
# installed, specify them here.
#
# If using Python 2.6 or earlier, then these have to be included in
# MANIFEST.in as well.
package_data={ # Optional
'sample': ['package_data.dat'],
},
# package_data={ # Optional
# 'sample': ['package_data.dat'],
# },

# Although 'package_data' is the preferred approach, in some case you may
# need to place data files outside of your packages. See:
# http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
#
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
data_files=[('my_data', ['data/data_file'])], # Optional
# data_files=[('my_data', ['data/data_file'])], # Optional

# To provide executable scripts, use entry points in preference to the
# "scripts" keyword. Entry points provide cross-platform support and allow
Expand All @@ -162,7 +178,7 @@
# executes the function `main` from this package when invoked:
entry_points={ # Optional
'console_scripts': [
'sample=sample:main',
'journalist=journalist:main',
],
},
)

0 comments on commit 2c1c9c0

Please sign in to comment.