Version 0.2.5 release

Changes: * Added `python3.6` and `Django==1.11` * Fixed `tests/settings` structure with `basic/` folder * Added documentation, which is built with `Sphinx` * Updated `README.rst` with `docs` badge * Updated `CONTRIBUTING.rst` with new information * Updates `travis.yml` with new logic Closes #16, closes #17
wemake-services · Apr 18, 2017 · 31ff49c · 31ff49c
1 parent 33e3993
commit 31ff49c
Show file tree

Hide file tree

Showing 11 changed files with 75 additions and 43 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,31 +1,18 @@
 language: python
 
 python:
-  - 3.5  # fix for the "`python3.5` is not found"
-
-env:
-  - TOX_ENV=py27-dj15
-  - TOX_ENV=py27-dj16
-  - TOX_ENV=py27-dj17
-  - TOX_ENV=py27-dj18
-  - TOX_ENV=py27-dj19
-  - TOX_ENV=py27-dj110
-  - TOX_ENV=py34-dj16
-  - TOX_ENV=py34-dj17
-  - TOX_ENV=py34-dj18
-  - TOX_ENV=py34-dj19
-  - TOX_ENV=py34-dj110
-  - TOX_ENV=py35-dj18
-  - TOX_ENV=py35-dj19
-  - TOX_ENV=py35-dj110
-  - TOX_ENV=lint
-  - TOX_ENV=cover
+  - 2.7
+  - 3.4
+  - 3.5
+  - 3.6
 
 install:
-  - pip install tox
+  - pip install tox-travis
 
 script:
-  - tox -e $TOX_ENV
+  - tox
+  - tox -e lint
+  - tox -e cover
 
 after_success:
   - coveralls
@@ -37,7 +24,6 @@ deploy:
   on:
     branch: master  # only in master branch
     tags: true  # deploy on tags only
-    condition: "${TOX_ENV} == 'cover'"  # deploy only once
 
 notifications:
   email:

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,22 @@
 Changelog
 ---------
 
+0.2.5
+~~~~~
+
+Improvements:
+
+* Added `python3.6` and `Django==1.11`
+* Fixed `tests/settings` structure with `basic/` folder
+* Added documentation, which is built with `Sphinx`
+* Updated `README.rst` with new logo
+* Updated `README.rst` with `docs` badge
+* Updated `CONTRIBUTING.rst` with new information
+
+Bugs:
+
+* Updated `README.rst` to be compatible with `PyPI`
+
 0.2.4
 ~~~~~
 

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -2,21 +2,36 @@
 Contributing
 ============
 
-If you want to make significant contribution to the project, please consider one one of the following tasks:
+Testing
+=======
+
+We are using ``pytest``, ``pylint``, and ``tox`` for testing.
+To run simple tests: ``python setup.py test``.
+To run full tests:
+
+.. code:: bash
 
-	* Writing extra tests.
-	* Rewrite ``test_merge`` function to test presence of all values.
-	* Write examples of best-practices of using ``django-split-settings``.
+    pip install tox
+    tox
+
+Make sure you have followed all the steps before submitting your PR.
 
 Before submitting
 =================
 
 Before submitting your code please do the following steps:
 
-	1. Run ``pylint`` with the default configuration all over your code.
-	2. Run tests with ``pytest examples``.
-	3. Run tests with all the Python interpreters with ``tox``.
-	4. Submit your code.
+	1. Run `tox` to make sure everything was working before
+	2. Add any changes you want
+	3. Adds tests for the new changes
+	4. Edit documentation if you have changed something significant
+	5. Run `tox` again to make sure it is still working
+
+Other help
+==========
+
+You can contribute by spreading a word about this library.
+It would also be a huge contribution to write a short article on how you are using this project. What are your best-practices?
 
 Authors
 =======

diff --git a/README.rst b/README.rst
@@ -17,19 +17,22 @@
 .. image:: https://img.shields.io/pypi/pyversions/django-split-settings.svg
      :target: https://pypi.python.org/pypi/django-split-settings
 
-Organize Django settings into multiple files and directories.  Easily
+.. image:: https://readthedocs.org/projects/django-split-settings/badge/?version=latest
+      :target: http://django-split-settings.readthedocs.io/en/latest/?badge=latest
+
+Organize Django settings into multiple files and directories. Easily
 override and modify settings. Use wildcards in settings file paths
 and mark settings files as optional.
 
 
 Requirements
-============
+------------
 
 We support ``django`` versions from ``1.5`` up to the most recent one.
 
 
 Installation
-============
+------------
 
 Install by using ``pip``:
 
@@ -39,7 +42,7 @@ Install by using ``pip``:
 
 
 Usage
-=====
+-----
 
 Replace your existing ``settings.py`` with a list of components that
 make up your Django settings.  Preferably create a settings package
@@ -67,7 +70,7 @@ previous files.
 
 
 Tips and tricks
-===============
+---------------
 
 You can use wildcards in file paths:
 
@@ -81,15 +84,15 @@ files are NOT in alphabetical order.
 
 
 Do you want to contribute?
-==========================
+--------------------------
 
 Read the `contributing`_ file.
 
 .. _contributing: https://github.com/sobolevn/django-split-settings/blob/master/CONTRIBUTING.rst
 
 
 Version history
-===============
+---------------
 
 See `changelog`_ file.
 

diff --git a/setup.py b/setup.py
@@ -9,10 +9,18 @@
 from setuptools import setup
 from split_settings import __version__
 
+
 INSTALL_REQUIRES = ['Django>=1.5', ]
-# pylint is not happy without this line:
-TESTS_REQUIRE = ['pytest', 'six', 'pytest-env', ]
-SETUP_REQUIRES = ['pytest-runner', ]
+
+TESTS_REQUIRE = [
+    'six',
+    'pytest',
+    'pytest-env',
+]
+
+SETUP_REQUIRES = [
+    'pytest-runner',
+]
 
 with io.open('README.rst', 'r', encoding='utf-8') as f:
     LONG_DESCRIPTION = f.read()
@@ -53,6 +61,7 @@
         'Framework :: Django :: 1.8',
         'Framework :: Django :: 1.9',
         'Framework :: Django :: 1.10',
+        'Framework :: Django :: 1.11',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',

diff --git a/split_settings/__init__.py b/split_settings/__init__.py
@@ -6,6 +6,6 @@
 settings files.
 """
 
-__version__ = '0.2.4'
+__version__ = '0.2.5'
 
 __all__ = ['__version__']
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -43,6 +43,7 @@ def fixture_file():
     """
     return os.path.join(
         'settings',
+        'basic',
         'fixture_to_include.py'
     )
 

diff --git a/tests/settings/fixture_to_include.py → tests/settings/basic/fixture_to_include.py b/tests/settings/fixture_to_include.py → tests/settings/basic/fixture_to_include.py
diff --git a/tests/test_tools.py b/tests/test_tools.py
@@ -47,7 +47,7 @@ def test_included_file_scope(scope, fixture_file):
 
     saved_file = os.path.join(
         base,
-        'settings',
+        'basic'
     )
 
     scope['__included_file__'] = saved_file

diff --git a/tests/test_unicode.py b/tests/test_unicode.py
@@ -21,6 +21,7 @@ def test_unicode_filename(scope):
 
     file_path = os.path.join(
         'settings',  # this should be written as string
+        'basic',
         'fixture_to_include.py'
     )
 

diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27-dj15, py{27,34}-dj{16,17}, py{27,34,35,36}-dj{18,19,110}, lint, cover
+envlist = py27-dj15, py{27,34}-dj{16,17}, py{27,34,35,36}-dj{18,19,110,111}, lint, cover
 
 [testenv]
 recreate = False
@@ -14,6 +14,7 @@ deps =
     dj18: Django<1.9
     dj19: Django<1.10
     dj110: Django<1.11
+    dj111: Django<1.12
 commands =
     py.test -rw .