Skip to content

Commit b81518f

Browse files
authored
Merge pull request #358 from satra/fix-pypi-readme
fix: readme for pypi
2 parents e92fb0f + aa6cae9 commit b81518f

File tree

5 files changed

+33
-27
lines changed

5 files changed

+33
-27
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## Acknowledgment
2+
- [ ] I acknowledge that this contribution will be available under the Apache 2 license.
3+
14
## Types of changes
25
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
36
- [ ] Bug fix (non-breaking change which fixes an issue)
@@ -16,6 +19,3 @@
1619
(we are using `black`: you can `pip install pre-commit`,
1720
run `pre-commit install` in the `pydra` directory
1821
and `black` will be run automatically with each commit)
19-
20-
## Acknowledgment
21-
- [ ] I acknowledge that this contribution will be available under the Apache 2 license.

README.rst

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,32 @@
1+
|GHAction| |CircleCI| |codecov|
12

2-
.. image:: https://raw.githubusercontent.com/nipype/pydra/master/docs/logo/pydra_logo.jpg
3-
:width: 50
4-
:alt: pydra logo
5-
6-
A simple dataflow engine with scalable semantics.
3+
|Pydralogo|
74

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

9-
.. image:: https://github.com/nipype/pydra/workflows/Pydra/badge.svg
9+
.. |GHAction| image:: https://github.com/nipype/pydra/workflows/Pydra/badge.svg
1010
:alt: GitHub Actions CI
1111
:target: https://github.com/nipype/Pydra/actions
1212

13-
|CircleCI|
13+
.. |CircleCI| image:: https://circleci.com/gh/nipype/pydra.svg?style=svg
14+
:alt: CircleCI
1415

15-
.. |CircleCI| image:: https://circleci.com/gh/nipype/pydra.svg?style=svg
16-
:alt: CircleCI
16+
.. |codecov| image:: https://codecov.io/gh/nipype/pydra/branch/master/graph/badge.svg
17+
:alt: codecov
1718

19+
======================
20+
Pydra: Dataflow Engine
21+
======================
1822

19-
|codecov|
23+
A simple dataflow engine with scalable semantics.
2024

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

24-
The goal of pydra is to provide a lightweight Python dataflow engine for DAG construction, manipulation, and distributed execution.
28+
The goal of pydra is to provide a lightweight Python dataflow engine for DAG
29+
construction, manipulation, and distributed execution.
2530

2631
Feature list:
2732
=============
@@ -59,10 +64,10 @@ Installation
5964
Note that installation fails with older versions of pip on Windows. Upgrade pip before installing:
6065

6166
::
62-
67+
6368
pip install –upgrade pip
6469
pip install pydra
65-
70+
6671

6772
Developer installation
6873
======================

min-requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Auto-generated by tools/update_min_requirements.py
2-
attrs
3-
cloudpickle >= 1.2.2
2+
attrs == 19.1.0
3+
cloudpickle == 1.2.2
44
filelock == 3.0.0
5-
etelemetry == 0.2.0
5+
etelemetry == 0.2.2

pydra/schema/context.jsonld

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"https://raw.githubusercontent.com/openprov/prov-jsonld/69964ed16818f78dc5f71bdf97add026288291d4/context.json",
1212
{
13-
"pydra": "https://s.pydra.org/",
13+
"pydra": "http://s.pydra.org/",
1414
"uid": "pydra:id/",
1515
"task": {
1616
"@id": "pydra:task",

setup.cfg

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[metadata]
22
url = https://github.com/nipype/pydra
3-
author = nipype developers
3+
author = Nipype developers
44
author_email = [email protected]
5-
maintainer = nipype developers
5+
maintainer = Nipype developers
66
maintainer_email = [email protected]
77
description = Pydra dataflow engine
8-
long_description = file:long_description.rst
8+
long_description = file:README.rst
99
long_description_content_type = text/x-rst; charset=UTF-8
1010
license = Apache License, 2.0
1111
provides =
@@ -18,6 +18,7 @@ classifiers =
1818
Operating System :: MacOS :: MacOS X
1919
Operating System :: POSIX :: Linux
2020
Programming Language :: Python :: 3.7
21+
Programming Language :: Python :: 3.8
2122
Topic :: Scientific/Engineering
2223

2324
[options]
@@ -29,7 +30,7 @@ install_requires =
2930
etelemetry >= 0.2.2
3031

3132
test_requires =
32-
pytest >= 4.4.0
33+
pytest >= 4.4.0, < 6.0.0
3334
pytest-cov
3435
pytest-env
3536
pytest-xdist < 2.0
@@ -61,7 +62,7 @@ doc =
6162
docs =
6263
%(doc)s
6364
test =
64-
pytest >= 4.4.0
65+
pytest >= 4.4.0, < 6.0.0
6566
pytest-cov
6667
pytest-env
6768
pytest-xdist < 2.0

0 commit comments

Comments
 (0)