Skip to content

Commit

Permalink
Last-minute fixes before release (#6)
Browse files Browse the repository at this point in the history
* REL: pin nx version to >= 2

turns out that trying to iterate through .nodes on nx versions < 2
causes problems. huh! we could modify the code to try to support old
nx versions, but easier to just require a modern nx version (nx 2
has been around for almost five years, anyway)

* DOC: consistently link to ref'd files in README

tiny little thing

* DEP/DOC: improve docs re nx pin

* REL: changelog wording

don't put words in anyone's mouth :P
  • Loading branch information
fedarko authored Jun 27, 2022
1 parent 30b0a44 commit 15e32bb
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ unsupported by pyfastg due to not being part of the general SPAdes FASTG dialect
### Performance improvements

N/A. The extra layers of validation added in this version might slow down
pyfastg slightly, but (in our opinion) this is worth it.
pyfastg slightly, but (in Marcus' opinion, at least) this is worth it.

### Development improvements
- Switched from Travis CI to GitHub Actions ([#3](https://github.com/fedarko/pyfastg/issues/3)).
Expand All @@ -111,6 +111,9 @@ pyfastg slightly, but (in our opinion) this is worth it.
non-development dependency of pyfastg is NetworkX. (That being said, we may
add more dependencies in the future if absolutely necessary.)

- On that note, pinned the minimum NetworkX version to 2. Earlier versions of
NetworkX seemed to have problems with pyfastg's use of `.nodes`.

## pyfastg v0.0.0 (October 14, 2019)

Initial release.
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ pip install pyfastg
```

pyfastg's only dependency (which should be installed automatically with
the above command) is [NetworkX](https://networkx.github.io).
the above command) is [NetworkX](https://networkx.github.io) ≥ 2.

As of writing, pyfastg supports all Python versions ≥ 3.6. pyfastg might be able to work with earlier versions of Python, but we do not explicitly test against these.

Expand Down Expand Up @@ -213,8 +213,10 @@ All of these commands are covered in pyfastg's
- Automtaically style the code: `make style`

## Changelog
See [`CHANGELOG.md`](https://github.com/fedarko/pyfastg/blob/master/CHANGELOG.md) for information on
the changes included with new pyfastg releases.
See pyfastg's
[`CHANGELOG.md`](https://github.com/fedarko/pyfastg/blob/master/CHANGELOG.md) file
for information on the changes included with new pyfastg releases.

## License
pyfastg is licensed under the MIT License. Please see the `LICENSE` file for details.
pyfastg is licensed under the MIT License. Please see pyfastg's
[`LICENSE`](https://github.com/fedarko/pyfastg/blob/master/LICENSE) file for details.
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@
with open("README.md") as f:
long_description = f.read()

version = "0.1.0"

setup(
name="pyfastg",
version=version,
version="0.1.0",
license="MIT",
description=description,
long_description=long_description,
Expand All @@ -32,6 +30,6 @@
url="https://github.com/fedarko/pyfastg",
classifiers=classifiers,
packages=find_packages(),
install_requires=["networkx"],
install_requires=["networkx >= 2"],
extras_require={"dev": ["pytest", "pytest-cov", "flake8", "black"]},
)

0 comments on commit 15e32bb

Please sign in to comment.