Geometric Graphs
Generate knowledge graphs with interesting geometries, like lattices. Works on Python 3.9+ because it uses cool new features. Get out of that 2020 funk and install the most recent version of Python.
๐ช
Getting Started
See https://github.com/cthoyt/translational-toys for example usage to generate charts like
.
๐
Installation
The most recent release can be installed from PyPI with:
$ pip install geometric_graphs
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/geometric-graphs.git
To install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/geometric-graphs.git
$ cd geometric-graphs
$ pip install -e .
๐
Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
๐
Attribution
โ๏ธ
License
The code in this package is licensed under the MIT License.
๐ช
Cookiecutter
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.
๐ ๏ธ
For Developers
See developer instrutions
The final section of the README is for if you want to get involved by making a code contribution.
โ
Testing
After cloning the repository and installing tox with pip install tox, the unit tests in the tests/ folder can be run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
๐ฆ
Making a Release
After installing the package in development mode and installing tox with pip install tox, the commands for making a new release are contained within the finish environment in tox.ini. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses BumpVersion to switch the version number in the
setup.cfgandsrc/geometric_graphs/version.pyto not have the-devsuffix - Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine. Be sure to have a.pypircfile configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can use
tox -e bumpversion minorafter.
7 Jul 06, 2022
675 Dec 09, 2022
1.3k Dec 31, 2022
706 Dec 28, 2022
7 Sep 06, 2022
185 Jan 06, 2023
280 Dec 19, 2022
78 Aug 23, 2022
1k Jan 01, 2023
98 Dec 29, 2022
4 Oct 10, 2022
9 Sep 20, 2022
12.7k Jan 05, 2023
3 Oct 10, 2022
744 Jan 06, 2023
166 Dec 01, 2022
3 Jan 03, 2023
265 Nov 21, 2022
2 Dec 05, 2021
1.2k Jan 01, 2023