Skip to content

Commit

Permalink
Merge pull request #358 from satra/fix-pypi-readme
Browse files Browse the repository at this point in the history
fix: readme for pypi
  • Loading branch information
satra authored Sep 26, 2020
2 parents e92fb0f + aa6cae9 commit b81518f
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 27 deletions.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## Acknowledgment
- [ ] I acknowledge that this contribution will be available under the Apache 2 license.

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
Expand All @@ -16,6 +19,3 @@
(we are using `black`: you can `pip install pre-commit`,
run `pre-commit install` in the `pydra` directory
and `black` will be run automatically with each commit)

## Acknowledgment
- [ ] I acknowledge that this contribution will be available under the Apache 2 license.
35 changes: 20 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
|GHAction| |CircleCI| |codecov|

.. image:: https://raw.githubusercontent.com/nipype/pydra/master/docs/logo/pydra_logo.jpg
:width: 50
:alt: pydra logo

A simple dataflow engine with scalable semantics.
|Pydralogo|

.. |Pydralogo| image:: https://raw.githubusercontent.com/nipype/pydra/master/docs/logo/pydra_logo.jpg
:width: 200px
:alt: pydra logo

.. image:: https://github.com/nipype/pydra/workflows/Pydra/badge.svg
.. |GHAction| image:: https://github.com/nipype/pydra/workflows/Pydra/badge.svg
:alt: GitHub Actions CI
:target: https://github.com/nipype/Pydra/actions

|CircleCI|
.. |CircleCI| image:: https://circleci.com/gh/nipype/pydra.svg?style=svg
:alt: CircleCI

.. |CircleCI| image:: https://circleci.com/gh/nipype/pydra.svg?style=svg
:alt: CircleCI
.. |codecov| image:: https://codecov.io/gh/nipype/pydra/branch/master/graph/badge.svg
:alt: codecov

======================
Pydra: Dataflow Engine
======================

|codecov|
A simple dataflow engine with scalable semantics.

.. |codecov| image:: https://codecov.io/gh/nipype/pydra/branch/master/graph/badge.svg
:alt: codecov
Pydra is a rewrite of the Nipype engine with mapping and joining as
first-class operations. It forms the core of the Nipype 2.0 ecosystem.

The goal of pydra is to provide a lightweight Python dataflow engine for DAG construction, manipulation, and distributed execution.
The goal of pydra is to provide a lightweight Python dataflow engine for DAG
construction, manipulation, and distributed execution.

Feature list:
=============
Expand Down Expand Up @@ -59,10 +64,10 @@ Installation
Note that installation fails with older versions of pip on Windows. Upgrade pip before installing:

::

pip install –upgrade pip
pip install pydra


Developer installation
======================
Expand Down
6 changes: 3 additions & 3 deletions min-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Auto-generated by tools/update_min_requirements.py
attrs
cloudpickle >= 1.2.2
attrs == 19.1.0
cloudpickle == 1.2.2
filelock == 3.0.0
etelemetry == 0.2.0
etelemetry == 0.2.2
2 changes: 1 addition & 1 deletion pydra/schema/context.jsonld
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
},
"https://raw.githubusercontent.com/openprov/prov-jsonld/69964ed16818f78dc5f71bdf97add026288291d4/context.json",
{
"pydra": "https://s.pydra.org/",
"pydra": "http://s.pydra.org/",
"uid": "pydra:id/",
"task": {
"@id": "pydra:task",
Expand Down
11 changes: 6 additions & 5 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[metadata]
url = https://github.com/nipype/pydra
author = nipype developers
author = Nipype developers
author_email = [email protected]
maintainer = nipype developers
maintainer = Nipype developers
maintainer_email = [email protected]
description = Pydra dataflow engine
long_description = file:long_description.rst
long_description = file:README.rst
long_description_content_type = text/x-rst; charset=UTF-8
license = Apache License, 2.0
provides =
Expand All @@ -18,6 +18,7 @@ classifiers =
Operating System :: MacOS :: MacOS X
Operating System :: POSIX :: Linux
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Topic :: Scientific/Engineering

[options]
Expand All @@ -29,7 +30,7 @@ install_requires =
etelemetry >= 0.2.2

test_requires =
pytest >= 4.4.0
pytest >= 4.4.0, < 6.0.0
pytest-cov
pytest-env
pytest-xdist < 2.0
Expand Down Expand Up @@ -61,7 +62,7 @@ doc =
docs =
%(doc)s
test =
pytest >= 4.4.0
pytest >= 4.4.0, < 6.0.0
pytest-cov
pytest-env
pytest-xdist < 2.0
Expand Down

0 comments on commit b81518f

Please sign in to comment.