Skip to content
This repository has been archived by the owner on Feb 8, 2023. It is now read-only.

Commit

Permalink
Modernize project structure
Browse files Browse the repository at this point in the history
- Modern .trovis.yml and tox.ini
- Modern python versions
- Rename .txt -> .rst
  • Loading branch information
jamadden committed Jun 16, 2017
1 parent 90a8e19 commit 0e489cf
Show file tree
Hide file tree
Showing 10 changed files with 99 additions and 35 deletions.
8 changes: 8 additions & 0 deletions .coveragerc
@@ -0,0 +1,8 @@
[run]
source = z3c.recipe.sphinxdoc

[report]
exclude_lines =
pragma: no cover
if __name__ == '__main__':
raise NotImplementedError
21 changes: 13 additions & 8 deletions .gitignore
@@ -1,9 +1,14 @@
*.pyc
__pycache__
src/*.egg-info

bin/
eggs/
develop-eggs/
parts/
.installed.cfg
.tox
bin
develop-eggs
parts
*.py[co]
__pycache__/
build/
dist/
*.egg-info/
.tox/
.coverage
.coverage.*
htmlcov/
30 changes: 22 additions & 8 deletions .travis.yml
@@ -1,12 +1,26 @@
language: python
sudo: false
python:
- 2.6
- 2.7
- 3.3
install:
- python bootstrap.py
- bin/buildout
- 2.7
- 3.4
- 3.5
- 3.6
- pypy-5.6.0
script:
- bin/test -v1
- coverage run -m zope.testrunner --test-path=src --auto-color --auto-progress

after_success:
- coveralls
notifications:
email: false
email: false

install:
- pip install -U pip setuptools
- pip install -U coveralls coverage
- pip install -U -e ".[test]"


cache: pip

before_cache:
- rm -f $HOME/.cache/pip/log/debug.log
6 changes: 4 additions & 2 deletions CHANGES.txt → CHANGES.rst
Expand Up @@ -2,10 +2,12 @@
CHANGES
=======

1.0.1 (unreleased)
1.1.0 (unreleased)
------------------

- Nothing changed yet.
- Add support for Python 3.4, 3.5 and 3.6 and PyPy.

- Remove support for Python 2.6 and 3.3.


1.0.0 (2013-02-23)
Expand Down
13 changes: 8 additions & 5 deletions MANIFEST.in
@@ -1,7 +1,10 @@
include *.txt
include *.py
include *.txt
include *.rst
include buildout.cfg

recursive-include src *

global-exclude *.pyc
include .travis.yml
include tox.ini
include .coveragerc
recursive-include src *.css
recursive-include src *.html
recursive-include src *.rst
1 change: 1 addition & 0 deletions README.rst
@@ -0,0 +1 @@
See src/z3c/recipe/sphinxdoc/index.txt for more information.
1 change: 0 additions & 1 deletion README.txt

This file was deleted.

32 changes: 21 additions & 11 deletions setup.py
Expand Up @@ -18,7 +18,8 @@
from setuptools import setup, find_packages

def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
with open(os.path.join(os.path.dirname(__file__), *rnames)) as f:
return f.read()

setup(
name="z3c.recipe.sphinxdoc",
Expand All @@ -27,39 +28,48 @@ def read(*rnames):
author_email="zope-dev@zope.org",
description="Use Sphinx to build documentation for zope.org.",
long_description=(
read(os.path.join('src','z3c','recipe','sphinxdoc','index.txt'))
read(os.path.join('src','z3c','recipe','sphinxdoc','index.rst'))
+'\n\n'+
read('CHANGES.txt')
),
read('CHANGES.rst')
),
keywords="buildout sphinx docs recipe",
license="ZPL 2.1",
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'License :: OSI Approved :: Zope Public License',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: PyPy',
'Natural Language :: English',
'Operating System :: OS Independent',
'Framework :: Buildout'],
url='https://pypi.python.org/pypi/z3c.recipe.sphinxdoc/',
'Framework :: Buildout',
],
url='https://github.com/zopefoundation/z3c.recipe.sphinxdoc/',
packages=find_packages('src'),
package_dir={'': 'src'},
namespace_packages=['z3c','z3c.recipe'],
install_requires=[
'setuptools',
'zc.buildout',
'zc.recipe.egg',
'docutils',
'Sphinx'],
'Sphinx',
],
extras_require={
'test': [
'zope.testrunner',
],
},
entry_points="""
[zc.buildout]
default = z3c.recipe.sphinxdoc:ZopeOrgSetup
""",
zip_safe=False,
include_package_data=True,
)
)
File renamed without changes.
22 changes: 22 additions & 0 deletions tox.ini
@@ -0,0 +1,22 @@
[tox]
envlist = py27,py34,py35,py36,pypy

[testenv]
commands =
coverage run -m zope.testrunner --test-path=src []
deps =
.[test]
coverage
setenv =
COVERAGE_FILE=.coverage.{envname}

[testenv:coverage]
setenv =
COVERAGE_FILE=.coverage
skip_install = true
commands =
coverage erase
coverage combine
coverage report
coverage html
coverage xml

0 comments on commit 0e489cf

Please sign in to comment.