Skip to content

Commit

Permalink
Initial release (and public commit)
Browse files Browse the repository at this point in the history
  • Loading branch information
xolox committed Aug 1, 2018
0 parents commit 5beb0c0
Show file tree
Hide file tree
Showing 37 changed files with 5,417 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# .coveragerc: Configuration file for coverage.py.
# http://nedbatchelder.com/code/coverage/

[run]
source = chat_archive
omit = chat_archive/tests.py

# vim: ft=dosini
41 changes: 41 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Changelog
=========

The purpose of this document is to list all of the notable changes to this
project. The format was inspired by `Keep a Changelog`_. This project adheres
to `semantic versioning`_.

.. contents::
:local:

.. _Keep a Changelog: http://keepachangelog.com/
.. _semantic versioning: http://semver.org/

`Release 4.0`_ (2018-08-01)
---------------------------

The initial public release! 🎉

Because I love giving mixed signals I've decided to use the version number 4.0
for this release (because four chat service backends are supported) but I've
added the "beta" trove classifier to the ``setup.py`` script and I've added a
big fat disclaimer to the readme (see the status section) 😛.

While publishing the project I decided to be pragmatic and strip the version
control history, because in the first weeks of development I hard coded quite a
few secrets in the code base. Since then I've added support for configuration
files and even ``~/.password-store`` but of course those secrets remain in the
history...

Now I could have spent hours pouring through tens of thousands of lines of
patch output to remove those secrets without trashing the history. Instead I
decided to do something more useful with my time, hence "pragmatic" above 😇.

PS. This is that *"awesome new project"* that I've been `referring to`_ in the
humanfriendly changelog. Over the course of developing `chat-archive` I've
moved more than `six hundred lines`_ of code to the humanfriendly package due
to its general purpose nature (the HTML to ANSI conversion).

.. _Release 4.0: https://github.com/xolox/python-chat-archive/tree/4.0
.. _referring to: http://humanfriendly.readthedocs.io/en/latest/changelog.html#release-4-13-2018-07-09
.. _six hundred lines: https://github.com/xolox/python-humanfriendly/compare/4.12.1...4.16.1
20 changes: 20 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2018 Peter Odding

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4 changes: 4 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
graft chat_archive/alembic
graft docs
include *.rst
include *.txt
74 changes: 74 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Makefile for the `chat-archive' package.
#
# Author: Peter Odding <peter@peterodding.com>
# Last Change: August 1, 2018
# URL: https://github.com/xolox/python-chat-archive

PACKAGE_NAME = chat-archive
WORKON_HOME ?= $(HOME)/.virtualenvs
VIRTUAL_ENV ?= $(WORKON_HOME)/$(PACKAGE_NAME)
PATH := $(VIRTUAL_ENV)/bin:$(PATH)
MAKE := $(MAKE) --no-print-directory
SHELL = bash

default:
@echo "Makefile for $(PACKAGE_NAME)"
@echo
@echo 'Usage:'
@echo
@echo ' make install install the package in a virtual environment'
@echo ' make reset recreate the virtual environment'
@echo ' make check check coding style (PEP-8, PEP-257)'
@echo ' make test run the test suite, report coverage'
@echo ' make tox run the tests on all Python versions'
@echo ' make readme update usage in readme'
@echo ' make docs update documentation using Sphinx'
@echo ' make publish publish changes to GitHub/PyPI'
@echo ' make clean cleanup all temporary files'
@echo

install:
@test -d "$(VIRTUAL_ENV)" || mkdir -p "$(VIRTUAL_ENV)"
@test -x "$(VIRTUAL_ENV)/bin/python" || virtualenv --python=python3.5 --quiet "$(VIRTUAL_ENV)"
@pip install --quiet --requirement=requirements.txt
@pip uninstall --yes $(PACKAGE_NAME) &>/dev/null || true
@pip install --no-deps --ignore-installed --quiet .

reset:
$(MAKE) clean
rm -Rf "$(VIRTUAL_ENV)"
$(MAKE) install

check: install
@pip install --upgrade --quiet --requirement=requirements-checks.txt
@flake8

test: install
@pip install --quiet --requirement=requirements-tests.txt
@py.test --cov
@coverage html

tox: install
@pip install --quiet tox && tox

readme: install
@pip install --quiet cogapp && cog.py -r README.rst

docs: readme
@pip install --quiet sphinx
@cd docs && sphinx-build -nb html -d build/doctrees . build/html

publish: install
git push origin && git push --tags origin
$(MAKE) clean
pip-accel install --quiet twine wheel
python setup.py sdist bdist_wheel
twine upload dist/*
$(MAKE) clean

clean:
@rm -Rf *.egg .cache .coverage .tox build dist docs/build htmlcov
@find -depth -type d -name __pycache__ -exec rm -Rf {} \;
@find -type f -name '*.pyc' -delete

.PHONY: default install reset check test tox readme docs publish clean

0 comments on commit 5beb0c0

Please sign in to comment.