From 8c5be1e3bae35247f5d752ab197154da0d6f58ec Mon Sep 17 00:00:00 2001 From: Eduardo Rodrigues Date: Thu, 2 Aug 2018 11:24:29 +0200 Subject: [PATCH] Update of links in README.md (#11) * Update README.md * Adding more fixed links * Better support for markdown readme in RtD and PyPI --- CHANGELOG.rst | 8 +++ CONTRIBUTING.rst | 8 +-- README.md | 8 +-- README.rst | 124 ---------------------------------------- ci/appveyor-download.py | 2 +- docs/conf.py | 4 +- docs/installation.rst | 4 +- docs/readme.rst | 2 +- setup.py | 9 +-- tox.ini | 2 +- 10 files changed, 26 insertions(+), 145 deletions(-) delete mode 100644 README.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 2868a432..a30a5adf 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,14 @@ Changelog ========= +0.2.0 (2018-07-24) +------------------ +* Moved to the SciKit-HEP project. +* Using new data package with importlib resources. +* Better docs and examples. +* Some method renaming +* Generalized converter script + 0.1.0 (2018-03-13) ------------------ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 531a282e..1e475f5c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -8,7 +8,7 @@ little bit helps, and credit will always be given. Bug reports =========== -When `reporting a bug `_ please include: +When `reporting a bug `_ please include: * Your operating system name and version. * Any details about your local setup that might be helpful in troubleshooting. @@ -24,7 +24,7 @@ articles, and such. Feature requests and feedback ============================= -The best way to send feedback is to file an issue at https://github.com/henryiii/decaylanguage/issues. +The best way to send feedback is to file an issue at https://github.com/scikit-hep/decaylanguage/issues. If you are proposing a feature: @@ -37,7 +37,7 @@ Development To set up `decaylanguage` for local development: -1. Fork `decaylanguage `_ +1. Fork `decaylanguage `_ (look for the "Fork" button). 2. Clone your fork locally:: @@ -74,7 +74,7 @@ For merging, you should: 4. Add yourself to ``AUTHORS.rst``. .. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will - `run the tests `_ for each change you add in the pull request. + `run the tests `_ for each change you add in the pull request. It will be slower though ... diff --git a/README.md b/README.md index 69ab40af..407b1826 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ [![DecayLanguage](images/DecayLanguage.png)](http://decaylanaguage.readthedocs.io/en/latest/) [![Documentation Status](https://readthedocs.org/projects/decaylanguage/badge/?style=flat)](https://readthedocs.org/projects/decaylanguage) -[![Travis-CI Build Status](https://travis-ci.org/henryiii/decaylanguage.svg?branch=master)](https://travis-ci.org/henryiii/decaylanguage) -[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/henryiii/decaylanguage?branch=master&svg=true)](https://ci.appveyor.com/project/HenrySchreiner/decaylanguage) -[![Coverage Status](https://coveralls.io/repos/henryiii/decaylanguage/badge.svg?branch=master&service=github)](https://coveralls.io/github/henryiii/decaylanguage) +[![Travis-CI Build Status](https://travis-ci.org/scikit-hep/decaylanguage.svg?branch=master)](https://travis-ci.org/scikit-hep/decaylanguage) +[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/scikit-hep/decaylanguage?branch=master&svg=true)](https://ci.appveyor.com/project/HenrySchreiner/decaylanguage) +[![Coverage Status](https://coveralls.io/repos/scikit-hep/decaylanguage/badge.svg?branch=master&service=github)](https://coveralls.io/github/scikit-hep/decaylanguage) [![PyPI Package latest release](https://img.shields.io/pypi/v/decaylanguage.svg)](https://pypi.python.org/pypi/decaylanguage) [![Supported versions](https://img.shields.io/pypi/pyversions/decaylanguage.svg)](https://pypi.python.org/pypi/decaylanguage) -[![Commits since latest release](https://img.shields.io/github/commits-since/henryiii/decaylanguage/v0.1.0.svg)](https://github.com/henryiii/decaylanguage/compare/v0.1.0...master) +[![Commits since latest release](https://img.shields.io/github/commits-since/scikit-hep/decaylanguage/v0.1.0.svg)](https://github.com/scikit-hep/decaylanguage/compare/v0.1.0...master) A language to describe particle decays, and tools to work with them. diff --git a/README.rst b/README.rst deleted file mode 100644 index 0b2c59d5..00000000 --- a/README.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. image:: images/DecayLanguage.png - :alt: DecayLanguage - :target: http://decaylanaguage.readthedocs.io/en/latest/ - -.. start-badges - -|docs| |travis| |appveyor| |coveralls| |version| |supported-versions| |commits-since| - - -.. |docs| image:: https://readthedocs.org/projects/decaylanguage/badge/?style=flat - :target: https://readthedocs.org/projects/decaylanguage - :alt: Documentation Status - -.. |travis| image:: https://travis-ci.org/henryiii/decaylanguage.svg?branch=master - :alt: Travis-CI Build Status - :target: https://travis-ci.org/henryiii/decaylanguage - -.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/henryiii/decaylanguage?branch=master&svg=true - :alt: AppVeyor Build Status - :target: https://ci.appveyor.com/project/HenrySchreiner/decaylanguage - -.. |requires| image:: https://requires.io/github/henryiii/decaylanguage/requirements.svg?branch=master - :alt: Requirements Status - :target: https://requires.io/github/henryiii/decaylanguage/requirements/?branch=master - -.. |coveralls| image:: https://coveralls.io/repos/henryiii/decaylanguage/badge.svg?branch=master&service=github - :alt: Coverage Status - :target: https://coveralls.io/github/henryiii/decaylanguage - -.. |version| image:: https://img.shields.io/pypi/v/decaylanguage.svg - :alt: PyPI Package latest release - :target: https://pypi.python.org/pypi/decaylanguage - -.. |commits-since| image:: https://img.shields.io/github/commits-since/henryiii/decaylanguage/v0.1.0.svg - :alt: Commits since latest release - :target: https://github.com/henryiii/decaylanguage/compare/v0.1.0...master - -.. |wheel| image:: https://img.shields.io/pypi/wheel/decaylanguage.svg - :alt: PyPI Wheel - :target: https://pypi.python.org/pypi/decaylanguage - -.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/decaylanguage.svg - :alt: Supported versions - :target: https://pypi.python.org/pypi/decaylanguage - -.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/decaylanguage.svg - :alt: Supported implementations - :target: https://pypi.python.org/pypi/decaylanguage - - -.. end-badges - -A language to describe particle decays, and tools to work with them. - - -Installation -============ - -Just run the following: - -:: - - pip install decaylanguage - - -You can use a virtual environment through `pipenv` or `--user` if you know what those are. - - -Strict dependencies: -==================== - -- `Python `__ (2.6+, 3.4+) -- `Numpy `__ -- `attrs `__ -- `enum34 `__ if using a Python version < 3.4 -- `pandas `__ -- `pathlib2 `__ if using a Python version < 3.5 -- `plumbum `__ -- `six `__ - - -Recommended dependencies: -========================= - -- `graphviz `__ to render (DOT language) graph descriptions of decay chains. - - -Usage -===== - -This is a quick user guide; for full API docs, see https://decaylanguage.readthedocs.io/en/latest/ - -DecayLanguage is a set of tools for building and transforming particle decays. The parts are: - -Particles ---------- - -You can use a variety of methods to get particles; if you know the PDG number you can get a particle directly, or you can use a search:: - - Particle.from_pdgid(211) - Particle.from_search_list(name='pi')[0] - -You can search for the properties, which are ``name``, ``mass``, ``width``, ``charge``, ``A``, ``rank``, ``I``, ``J``, ``G``, ``P``, -``quarks``, ``status``, ``latex``, ``mass_upper``, ``mass_lower``, ``width_upper``, and ``width_lower`` (some of those don't make sense). -You can also use ``from_search`` to require only one match. - -Once you have a particle, any of the properties can be accessed, along with several methods. -Though they are not real properties, you can access ``bar``, ``radius``, and ``spin_type``. -You can also ``invert()`` a particle. There are lots of printing choices, ``describe()``, ``programmatic_name()``, ``html_name()``, -html printing outs in notebooks, and of course ``repr`` and ``str`` support. - -Decays ------- - -The most common way to create a decay chain is to read in an AmpGen style syntax from a file or a string. - -Converters ----------- - -You can output to a format (currently only GooFit supported, feel free to make a PR to add more). Use a subclass of `DecayChain`, in this case, `GooFitChain`. - -Acknowledgements -================ -Decay Language is free software released under a BSD 3-Clause License. It was originally developed by Henry Schreiner. diff --git a/ci/appveyor-download.py b/ci/appveyor-download.py index 3b47789a..cac4d7d7 100755 --- a/ci/appveyor-download.py +++ b/ci/appveyor-download.py @@ -95,7 +95,7 @@ def unpack_zipfile(filename): parser = argparse.ArgumentParser(description='Download artifacts from AppVeyor.') parser.add_argument('--id', metavar='PROJECT_ID', - default='henryiii/decaylanguage', + default='scikit-hep/decaylanguage', help='Project ID in AppVeyor.') parser.add_argument('build', nargs='?', diff --git a/docs/conf.py b/docs/conf.py index 16deaca8..bb86388e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,8 +31,8 @@ pygments_style = 'trac' templates_path = ['.'] extlinks = { - 'issue': ('https://github.com/henryiii/decaylanguage/issues/%s', '#'), - 'pr': ('https://github.com/henryiii/decaylanguage/pull/%s', 'PR #'), + 'issue': ('https://github.com/scikit-hep/decaylanguage/issues/%s', '#'), + 'pr': ('https://github.com/scikit-hep/decaylanguage/pull/%s', 'PR #'), } # on_rtd is whether we are on readthedocs.org on_rtd = os.environ.get('READTHEDOCS', None) == 'True' diff --git a/docs/installation.rst b/docs/installation.rst index 69f930b7..98ed0bb1 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -2,12 +2,12 @@ Installation ============ -At the command line (not active until the first release):: +At the command line:: pip install decaylanguage Or:: - pip install https://github.com/henryiii/decaylanguage.git + pip install https://github.com/scikit-hep/decaylanguage.git diff --git a/docs/readme.rst b/docs/readme.rst index 72a33558..97d49585 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -1 +1 @@ -.. include:: ../README.rst +.. mdinclude:: ../README.md diff --git a/setup.py b/setup.py index 633ae5ae..6f094c6b 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,6 @@ from __future__ import print_function import io -import re from os.path import dirname from os.path import join @@ -24,13 +23,11 @@ def read(*names, **kwargs): version='0.1.0', license='BSD 3-Clause License', description='A language to describe particle decays, and tools to work with them.', - long_description='%s\n%s' % ( - re.compile('^.. start-badges.*^.. end-badges', re.M | re.S).sub('', read('README.rst')), - re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst')) - ), + long_description=read('README.md'), + long_description_content_type="text/markdown", author='Henry Fredrick Schreiner III', author_email='henry.schreiner@cern.ch', - url='https://github.com/henryiii/decaylanguage', + url='https://github.com/scikit-hep/decaylanguage', packages=find_packages(), include_package_data=True, zip_safe=True, diff --git a/tox.ini b/tox.ini index f5bcdae1..7313b9d0 100644 --- a/tox.ini +++ b/tox.ini @@ -57,7 +57,7 @@ deps = isort skip_install = true commands = - python setup.py check --strict --metadata --restructuredtext + python setup.py check --strict --metadata check-manifest {toxinidir} flake8 decaylanguage tests setup.py isort --verbose --check-only --diff --recursive decaylanguage tests setup.py