From 0a9205c3b12c6a27bbe4d347ea773030ca411bd4 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Fri, 14 Dec 2018 23:23:07 +0000 Subject: [PATCH 1/3] Ignore egg files. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 7bc9267..ac9d37c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ xppl/cover/** xppl/uploads/** .tox .env +*.egg-info/ -- 2.39.5 From 4ee38230b5864f5fe32c2884b20f99d9afb5e158 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Fri, 14 Dec 2018 23:23:18 +0000 Subject: [PATCH 2/3] Add a dummy setuptools file. Will probably just use this for versioning which can match up in the CHANGELOG.md to help people see which version to install. No releases are tagged so far though. --- setup.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 setup.py diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..99af33b --- /dev/null +++ b/setup.py @@ -0,0 +1,21 @@ +"""Package information.""" + +from setuptools import find_packages, setup + +with open('README.md', 'r') as handle: + long_description = handle.read() + +setup( + name='xppl', + version='0.0.2', + description='An experimental library.', + long_description=long_description, + long_description_content_type='text/markdown', + packages=find_packages(exclude=['tests']), + platforms='any', + classifiers=[ + 'Environment :: Web Environment', + 'Framework :: Flask', + 'Programming Language :: Python :: 3', + ] +) -- 2.39.5 From aa979a2ee996cc46a7a5272d8969e41115c2d5dd Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Fri, 14 Dec 2018 23:24:06 +0000 Subject: [PATCH 3/3] Add a first stab at a change log. To help us all keep a handle on the changes going down. --- CHANGELOG.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..76dc399 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,43 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +--- + +## [0.0.2] - 2018-11-18 + +Deployed on: +* https://books.vvvvvvaria.org/ + +### Added +* Use [Pipenv](https://pipenv.readthedocs.io/en/latest/) for dependency management. +* A bootstrap [scripts](scripts) folder for running development server and shell. +* Add a dummy test suite which uses [pytest](https://docs.pytest.org/en/latest/). +* An [Ansible](https://docs.ansible.com/) deployment method in the [ansible](ansible) folder. +* Add documentation in [README.md](README.md) and [ansible/README.md](ansible/README.md). + +### Changed +* Move all application source code into the [xppl](xppl) folder. +* Bootstrap the application via [xppl/app.py](xppl/app.py). +* Added [Makefile](Makefile) targets for installing [RQLite](https://github.com/rqlite/rqlite). +* Run [isort](https://isort.readthedocs.io/en/latest/) and [pylava](https://github.com/pylava/pylava) + code audit tools over the source to use PEP 8 style, catch any erroneous + imports, unused variables etc. with some basic static analysis. +* Use a new [Hypothesis](https://web.hypothes.is/) API key. + +### Fixed +* A bug in the scrolling homepage message where missing information resulted in a NoneType error. + +### Removed +* The `import_csv.py` since we'll probably use [Alembic](https://alembic.sqlalchemy.org/en/latest/) migrations instead. +* The `rebuild.py` since it appears the application doesn't use [Whoosh](https://whoosh.readthedocs.io/en/latest/intro.html) any more. +* The basic `init.py` which originally built the database. Done in [xppl/app.py](xppl/app.py) now. + +## [0.0.1] - 2018-10-29 + +* Initial release. No change log entries. -- 2.39.5