microsoft
/
topologic
зеркало из https://github.com/microsoft/topologic.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
A python library for intelligently building networks and network embeddings, and for analyzing connected data.
10 коммитов 9 Ветки 3 Теги 5,6 MiB
Python 69.4%
Jupyter Notebook 30.4%
Makefile 0.2%
Перейти к файлу
Dwayne Pryce 1917c8e6b1 Missing typeshed hints for testfixtures and pytest 2020-02-10 12:02:27 -08:00
docs Initial commit 2020-02-10 11:30:24 -08:00
notebooks Initial commit 2020-02-10 11:30:24 -08:00
tests Initial commit 2020-02-10 11:30:24 -08:00
topologic Initial commit 2020-02-10 11:30:24 -08:00
.gitattributes Initial commit 2020-02-10 11:30:24 -08:00
.gitignore Initial commit 2020-02-10 11:30:24 -08:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2020-02-06 12:44:40 -08:00
LICENSE Initial LICENSE commit 2020-02-06 12:44:41 -08:00
MANIFEST.in Initial commit 2020-02-10 11:30:24 -08:00
Makefile Turns out mypy has been quietly not running for (seemingly) months. We have errors in our unit tests. 2020-02-10 12:02:27 -08:00
README.md Started writing the documentation for macOS but it failed to open our setup.py 2020-02-10 12:02:27 -08:00
SECURITY.md Initial SECURITY.md commit 2020-02-06 12:44:43 -08:00
docs_version_for_file_name.py Initial commit 2020-02-10 11:30:24 -08:00
mypy.ini Missing typeshed hints for testfixtures and pytest 2020-02-10 12:02:27 -08:00
requirements.txt Initial commit 2020-02-10 11:30:24 -08:00
setup.cfg Initial commit 2020-02-10 11:30:24 -08:00
setup.py Initial commit 2020-02-10 11:30:24 -08:00

README.md

Topologic

Release Status

Topologic has yet to be published to PyPi, and the documentation has yet to be generated and published to Read the Docs.

Bugs or Feature Requests

Please file a new issue if you find any bugs, either in the code or the documentation.

Development Setup Instructions

git-lfs is highly suggested.

Topologic was developed for Python 3.5+ and makes extensive use of type hints throughout. Python 2.7 is not supported.

Topologic is known to work with Python x64 3.6, 3.7, and 3.8 on Windows and Ubuntu, and presumed to work on MacOS as well. Please submit a new issue with any issues

Windows

TODO: instructions

MacOS

python3 -m venv venv
source venv/bin/activate
pip install -U setuptools wheel pip

Ubuntu

sudo apt-get update && sudo apt-get install python3-pip python3-dev
python3 -m venv venv
source venv/bin/activate
pip install -U setuptools wheel pip

Running Tests

mypy -m topologic
mypy -m tests
flake8 ./topologic ./tests
pytest tests topologic --doctest-modules

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Privacy

topologic does not collect, store, or transmit any information of any kind back to Microsoft.

For your convenience, here is the link to the general Microsoft Privacy Statement.