diff --git a/.gitignore b/.gitignore index 7bbc71c..ad39bf0 100644 --- a/.gitignore +++ b/.gitignore @@ -99,3 +99,9 @@ ENV/ # mypy .mypy_cache/ + +# Editor temporary files +*.swp +*.bak +*.tmp + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a189f02 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +## CHANGELOG: pent - Pent Extracts Numerical Text + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +### [Unreleased] + +#### Features + + * ... \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..ae496ce --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include LICENSE.txt README.rst CHANGELOG.md \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index adfe456..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# pent -Pent Extracts Numerical Text diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..86b1d9a --- /dev/null +++ b/README.rst @@ -0,0 +1,9 @@ +pent +==== + +*Pent Extracts Numerical Text* + +Mini-language driven parser for structured numerical data. + +*Development impending...* + diff --git a/pent/__init__.py b/pent/__init__.py new file mode 100644 index 0000000..a1946a1 --- /dev/null +++ b/pent/__init__.py @@ -0,0 +1,28 @@ +# ---------------------------------------------------------------------------- +# Name: __init__ +# Purpose: Package definition module for pent +# +# Author: Brian Skinn +# bskinn@alum.mit.edu +# +# Created: 14 Nov 2017 +# Copyright: (c) Brian Skinn 2017 +# License: The MIT License; see "LICENSE.txt" for full license terms +# and contributor agreement. +# +# This file is part of 'pent', a package for parsing of structured +# numerical text. +# +# http://www.github.com/bskinn/pent +# +# ---------------------------------------------------------------------------- + + +"""Definition file for root of pent.""" + + +from __future__ import absolute_import + +__all__ = [] + +__version__ = '0.0' diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..8697953 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,9 @@ +attrs<18 +sphinx==1.6.5 +sphinx_rtd_theme==0.2.4 +ipython +flake8 +flake8-docstrings +coverage +tox +wget diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..3f76e04 --- /dev/null +++ b/setup.py @@ -0,0 +1,31 @@ +from setuptools import setup + + +def readme(): + with open('README.rst', 'r') as f: + return f.read() + + +setup( + name='pent', + version='0.0', + packages=['pent'], + url='https://www.github.com/bskinn/pent', + license='MIT License', + author='Brian Skinn', + author_email='bskinn@alum.mit.edu', + description='Pent Extracts Numerical Text', + long_description=readme(), + classifiers=['License :: OSI Approved :: MIT License', + 'Natural Language :: English', + 'Intended Audience :: Science/Research', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3 :: Only', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Topic :: Scientific/Engineering', + 'Topic :: Scientific/Engineering :: Mathematics', + 'Topic :: Utilities', + 'Development Status :: 1 - Planning'], +)