Prepare release 0.1.2
- Update documentation - Add Pipfile and Pipfile.lock to allow using pipenv - Update development URLs - Bump copyright years
This commit is contained in:
parent
94cdbf19d5
commit
d35fd33b3f
6 changed files with 393 additions and 59 deletions
|
@ -1,8 +1,14 @@
|
|||
Changelog
|
||||
=========
|
||||
|
||||
* :release:`0.1.2 <2020-02-29>`
|
||||
* :bug:`-` Update dependencies for Debian Buster compatibility
|
||||
* :support:`-` Add `Pipfile` and `Pipfile.lock` for more modern dependency
|
||||
management
|
||||
|
||||
* :release:`0.1.1 <2019-03-22>`
|
||||
* :bug:`-` Remove fixed kombu version due to incompatibility with current
|
||||
Python 2.7, update amqp to 1.4.9
|
||||
|
||||
* :release:`0.1.0 <2015-01-04>`
|
||||
* :feature:`-` initial project setup
|
||||
|
|
15
docs/conf.py
15
docs/conf.py
|
@ -20,6 +20,13 @@ import os
|
|||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
sys.path.insert(0, os.path.abspath(os.path.join('..', 'gvamysql')))
|
||||
|
||||
os.environ['GVAMYSQL_BROKER_URL'] = 'amqp://'
|
||||
os.environ['GVAMYSQL_DBADMIN_HOST'] = 'localhost'
|
||||
os.environ['GVAMYSQL_DBADMIN_PORT'] = "3306"
|
||||
os.environ['GVAMYSQL_DBADMIN_USER'] = "gvamysql"
|
||||
os.environ['GVAMYSQL_DBADMIN_PASSWORD'] = "sUp3rS3cr3t"
|
||||
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
|
@ -32,9 +39,9 @@ extensions = ['releases', 'sphinx.ext.autodoc', 'celery.contrib.sphinx']
|
|||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
releases_issue_uri = 'https://dev.gnuviech-server.de/gvamysql/ticket/%s'
|
||||
releases_issue_uri = 'https://git.dittberner.info/gnuviech/gvamysql/issues/%s'
|
||||
|
||||
releases_release_uri = 'https://dev.gnuviech-server.de/gvamysql/milestone/%s'
|
||||
releases_release_uri = 'https://git.dittberner.info/gnuviech/gvamysql/src/tag/%s'
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
@ -47,7 +54,7 @@ master_doc = 'index'
|
|||
|
||||
# General information about the project.
|
||||
project = u'gvamysql'
|
||||
copyright = u'2014, 2015 Jan Dittberner'
|
||||
copyright = u'2014-2020 Jan Dittberner'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
|
@ -56,7 +63,7 @@ copyright = u'2014, 2015 Jan Dittberner'
|
|||
# The short X.Y version.
|
||||
version = '0.1'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '0.1.0'
|
||||
release = '0.1.2'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
@ -7,64 +7,17 @@ Install
|
|||
Working Environment
|
||||
===================
|
||||
|
||||
You have several options in setting up your working environment. We recommend
|
||||
using virtualenv to separate the dependencies of your project from your
|
||||
system's python environment. If on Linux or Mac OS X, you can also use
|
||||
virtualenvwrapper to help manage multiple virtualenvs across different
|
||||
projects.
|
||||
To get a running work environment use `pipenv`_.
|
||||
|
||||
.. index:: virtualenv
|
||||
.. _pipenv: https://pipenv.kennethreitz.org/en/latest/
|
||||
|
||||
Virtualenv Only
|
||||
---------------
|
||||
|
||||
First, make sure you are using `virtualenv`_. Once that's installed, create
|
||||
your virtualenv:
|
||||
To get started install `pip` and `pipenv` and use `pipenv install --dev`:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ virtualenv --distribute gvamysql
|
||||
|
||||
.. _virtualenv: https://virtualenv.pypa.io/en/latest/
|
||||
|
||||
You will also need to ensure that the virtualenv has the project directory
|
||||
added to the path.
|
||||
|
||||
.. index:: virtualenvwrapper
|
||||
|
||||
Virtualenv with virtualenvwrapper
|
||||
------------------------------------
|
||||
|
||||
In Linux and Mac OSX, you can install `virtualenvwrapper
|
||||
<http://virtualenvwrapper.readthedocs.org/en/latest/>`_, which will take care
|
||||
of managing your virtual environments and adding the project path to the
|
||||
`site-directory` for you:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ mkdir gvamysql
|
||||
$ mkvirtualenv -a gvamysql gvamysql-dev
|
||||
$ cd gvamysql && add2virtualenv `pwd`
|
||||
|
||||
|
||||
.. index:: pip, requirements, dependencies
|
||||
|
||||
Installation of Dependencies
|
||||
=============================
|
||||
|
||||
Depending on where you are installing dependencies:
|
||||
|
||||
In development:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ pip install -r requirements/local.txt
|
||||
|
||||
For production:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ pip install -r requirements.txt
|
||||
$ apt install python3-pip
|
||||
$ python3 -m pip install --user -U pipenv
|
||||
$ pipenv install --dev
|
||||
|
||||
.. index:: celery, worker, file queue
|
||||
|
||||
|
@ -78,6 +31,6 @@ into the gvamysql directory and run the celery worker with:
|
|||
.. code-block:: sh
|
||||
|
||||
$ cd gvamysql
|
||||
$ celery -A gvamysql worker -Q mysql -l info
|
||||
$ pipenv run celery -A gvamysql worker -Q mysql -l info
|
||||
|
||||
.. _Celery: http://www.celeryproject.org/
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue