Skip to content

Commit

Permalink
Update setup.py and doc index
Browse files Browse the repository at this point in the history
  • Loading branch information
joealcorn committed Jan 23, 2018
1 parent c093f15 commit 2cc5cb8
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
19 changes: 10 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 8,15 @@ Laboratory

A Python library for carefully refactoring critical paths with support for Python 2.7 & 3.3

Laboratory helps us refactor important code paths with confidence. By conducting experiments
and verifying their results, we can not only see if our unproven code is misbehaving, we have
established a feedback loop that we can use to guide us towards the correct behaviour.
Laboratory is all about sure-footed refactoring achieved through experimentation. By conducting
experiments and verifying their results, not only can we see if our refactored code is
misbehaving, we have established a feedback loop to help us correct its behaviour.


.. note:: These docs are a work in progress. Additional documentation can be found in the
project's `README <https://github.com/joealcorn/laboratory#laboratory->`_



.. toctree::
:maxdepth: 2
Expand All @@ -20,17 26,12 @@ established a feedback loop that we can use to guide us towards the correct beha
publishing
reference


.. note:: These docs are a work in progress. Additional documentation can be found on the
`project's github page <https://github.com/joealcorn/laboratory>`_


.. _quickstart:

Quickstart
----------

See: :ref:`installation` or ``pip install laboratory``
See: :ref:`installation` or ``pip install laboratory==1.0.dev0``


With Laboratory you conduct an experiment with your known-good code as the
Expand Down
10 changes: 6 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 12,7 @@
name='laboratory',
packages=find_packages(),
version=laboratory.__version__,
description="A Python port of Github's Scientist lib.",
description="Sure-footed refactoring achieved through experimenting",
long_description=long_description,
author='Joe Alcorn',
author_email='[email protected]',
Expand All @@ -26,10 26,10 @@
},
license='MIT',
classifiers=[
'License :: OSI Approved :: MIT License',
'Development Status :: 4 - Beta',
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Topic :: Software Development :: Testing',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
Expand All @@ -39,5 39,7 @@
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Topic :: Software Development :: Testing',
'Topic :: Utilities',
]
)

0 comments on commit 2cc5cb8

Please sign in to comment.