diff --git a/AUTHORS b/AUTHORS index 16c35724..1eea6aad 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,18 +1,22 @@ -Coveralls is written and maintained by Ilya Baryshev and various contributors: +Coveralls is written and maintained by various contributors: -* Jessamyn Smith -* Damian Fuentes -* Yaroslav Halchenko -* Steve Lamb * Aaron Meurer * Alex Gaynor -* Daniël Franke -* Isaac Slavitt -* Ionel Cristian Mărieș * Artem Malyshev * Chase Lee -* Samuel Colvin +* Damian Fuentes +* Daniël Franke * David Zuber -* Tomasz Anielak +* Gonzalo Peña-Castellanos +* Ionel Cristian Mărieș +* Isaac Slavitt +* Jessamyn Smith +* Kevin James * Liam Costello * Maksim Koryukov +* Samuel Colvin +* Steve Lamb +* Tomasz Anielak +* Yaroslav Halchenko + +Special thanks goes to the original maintainer, Ilya Baryshev. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a698a225..8752bdb1 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,16 +1,16 @@ Changelog ---------- +========= 1.1 (2015-10-04) -~~~~~~~~~~~~~~~~ -* Suupport for Circle CI +---------------- +* Support for Circle CI 1.0 (2015-09-17) -~~~~~~~~~~~~~~~~ +---------------- * Official coverage 4.0 support 1.0b1 (2015-08-14) -~~~~~~~~~~~~~~~~~~ +------------------ * Coverage 4 beta support * Codeship experimetal support (CI_BRANCH env variable) * Drop python 3.2 support (as coverage 4 does not support it) @@ -18,62 +18,62 @@ Changelog * Error reporting is improved, exist status codes added 1.0a2 (2015-02-19) -~~~~~~~~~~~~~~~~~~ +------------------ * Fix latest alpha coverage.py support * Remove erroneous warning message when writing output to a file 1.0a1 (2015-02-19) -~~~~~~~~~~~~~~~~~~ +------------------ * **Backwards incompatible**: make pyyaml optional. If you're using .coveralls.yml, make sure to install coveralls[yaml] * Coverage 4 alpha support * Allow debug and output options to work without repo_token * Fix merge command for python 3.X 0.5 (2014-12-10) -~~~~~~~~~~~~~~~~ +---------------- * Add option --output= for saving json to file for possible merging with coverages from other languages * Add merge command for sending coverage stats from multiple languages 0.4.4 (2014-09-28) -~~~~~~~~~~~~~~~~~~ +------------------ * Proper fix coverage.py dependency version 0.4.3 (2014-09-28) -~~~~~~~~~~~~~~~~~~ +------------------ * Fix coverage.py dependency version 0.4.2 (2014-05-05) -~~~~~~~~~~~~~~~~~~ +------------------ * Handle 503 errors from coveralls.io 0.4.1 (2014-01-15) -~~~~~~~~~~~~~~~~~~ +------------------ * Fix gitlog output with utf8 0.4 (2013-12-27) -~~~~~~~~~~~~~~~~ +---------------- * Added support for --rcfile= option to cli * Improved docs: nosetests and troubleshooting sections added * Added debug in case of UnicodeDecodeError * Removed sh dependency in favor of Windows compatibility 0.3 (2013-10-02) -~~~~~~~~~~~~~~~~ +---------------- * Added initial support for Circle CI * Fixed Unicode not defined error in python 3 0.2 (2013-05-26) -~~~~~~~~~~~~~~~~ +---------------- * Python 3.2 and PyPy support * Graceful handling of coverage exceptions * Fixed UnicodeDecodeError in json encoding * Improved readme 0.1.1 (2013-02-13) -~~~~~~~~~~~~~~~~~~ +------------------ * Introduced COVERALLS_REPO_TOKEN environment variable as a fallback for Travis * Removed repo_token from verbose output for security reasons 0.1 (2013-02-12) -~~~~~~~~~~~~~~~~ +---------------- * Initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.rst similarity index 98% rename from CONTRIBUTING.md rename to CONTRIBUTING.rst index fc83f780..222dbcdc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.rst @@ -1,9 +1,12 @@ Issues ====== + If you're opening a support ticket about coveralls not working, please add ``coveralls debug`` output. Pull requests ============= + Pull requests with untested code will not be merged straight away. + If you would like to speed up the process, please, write tests. diff --git a/README.rst b/README.rst index a96c833a..5025762a 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,11 @@ Coveralls for python ==================== -.. image:: https://img.shields.io/coveralls/coagulant/coveralls-python.svg - :target: https://coveralls.io/r/coagulant/coveralls-python +.. image:: https://img.shields.io/coveralls/coveralls-clients/coveralls-python.svg + :target: https://coveralls.io/r/coveralls-clients/coveralls-python -.. image:: https://img.shields.io/travis/coagulant/coveralls-python/master.svg - :target: https://travis-ci.org/coagulant/coveralls-python +.. image:: https://img.shields.io/travis/coveralls-clients/coveralls-python/master.svg + :target: https://travis-ci.org/coveralls-clients/coveralls-python .. image:: https://img.shields.io/pypi/v/coveralls.svg :target: https://pypi.python.org/pypi/coveralls @@ -13,7 +13,7 @@ Coveralls for python .. image:: https://img.shields.io/pypi/pyversions/coveralls.svg :target: https://pypi.python.org/pypi/coveralls/ -.. image:: https://img.shields.io/pypi/dd/coveralls.svg +.. .. image:: https://img.shields.io/pypi/dd/coveralls.svg :target: https://pypi.python.org/pypi/coveralls/ `Coveralls.io`_ is service to publish your coverage stats online with a lot of `nice features`_. diff --git a/RELEASE.rst b/RELEASE.rst new file mode 100644 index 00000000..f5e88c13 --- /dev/null +++ b/RELEASE.rst @@ -0,0 +1,28 @@ +Release +======= + +This project is released on PyPI as `coveralls`_. + +To cut a new release, ensure the latest master passes all tests. Then, create a release commit: + +1. Update the :code:`CHANGELOG.rst` with the new version. +2. Bump the version number in :code:`version.py`. +3. Tag that commit with the version number (:code:`git tag x.y.z`). + +Make sure to push the release commit to GitHub. + +To create a new PyPI release, do the following: + +1. Build the sources (:code:`python setup.py sdist bdist_wheel`). +2. Register & upload the sources. We recommend using `twine`_. + * to register: :code:`twine register dist/coveralls-x.y.z.tar.gz`, etc. + * to upload: :code:`twine upload dist/*` + +NOTE: in the future, we may want to expand this to include other sources, such as eggs for various Python versions. Since we already test with :code:`tox`, this could be as simple as:: + + .tox/py34/bin/python setup.py bdist_egg + .tox/py35/bin/python setup.py bdist_egg + # etc + +.. _`coveralls`: https://pypi.org/project/coveralls/ +.. _`twine`: https://pypi.org/project/twine/ diff --git a/coveralls/__init__.py b/coveralls/__init__.py index bf772dca..e0a24b1e 100644 --- a/coveralls/__init__.py +++ b/coveralls/__init__.py @@ -1,5 +1,7 @@ # coding: utf-8 from .api import Coveralls +from .version import __version__ + __all__ = ['api'] diff --git a/coveralls/cli.py b/coveralls/cli.py index 07f9aaff..a94fd608 100644 --- a/coveralls/cli.py +++ b/coveralls/cli.py @@ -31,13 +31,14 @@ from docopt import docopt from coveralls import Coveralls from coveralls.api import CoverallsException +from coveralls.version import __version__ log = logging.getLogger('coveralls') def main(argv=None): - options = docopt(__doc__, argv=argv) + options = docopt(__doc__, argv=argv, version=__version__) if options['debug']: options['--verbose'] = True level = logging.DEBUG if options['--verbose'] else logging.INFO diff --git a/coveralls/version.py b/coveralls/version.py new file mode 100644 index 00000000..439eb0cd --- /dev/null +++ b/coveralls/version.py @@ -0,0 +1 @@ +__version__ = '1.1' diff --git a/setup.py b/setup.py index 3f21cdaa..55f707e8 100644 --- a/setup.py +++ b/setup.py @@ -1,17 +1,24 @@ +import os from setuptools import setup +VERSION_FILE = os.path.join(os.path.abspath(os.path.dirname(__file__)), + 'coveralls', 'version.py') + DESCRIPTION = open('README.rst').read() + '\n\n' + open('CHANGELOG.rst').read() +VERSION = None +with open(VERSION_FILE, 'r') as f: + VERSION = f.read().split()[2] + setup( name='coveralls', - version='1.1', + version=VERSION, packages=['coveralls'], - url='http://github.com/coagulant/coveralls-python', + url='http://github.com/coveralls-clients/coveralls-python', license='MIT', - author='Ilya Baryshev', - author_email='baryshev@gmail.com', + author='coveralls-clients contributors', description='Show coverage stats online via coveralls.io', long_description=DESCRIPTION, entry_points={