Metadata-Version: 2.2
Name: transport_frames
Version: 2.0.1
Summary: IDU research package boilerplate
Author-email: Polina Krupenina <krupenina.p@mail.ru>
Project-URL: Repository, https://github.com/blackcoster/transport_frames
Project-URL: Bug Tracker, https://github.com/blackcoster/transport_frames/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: geopandas<0.15,>=0.12
Requires-Dist: osmnx==1.9.4
Requires-Dist: networkx>=3.2
Requires-Dist: contextily==1.6.2
Requires-Dist: folium==0.14.0
Requires-Dist: momepy==0.9.1
Requires-Dist: mapclassify==2.6.1
Requires-Dist: pyogrio==0.10.0
Requires-Dist: pandas>=2.1
Requires-Dist: pyarrow==19.0.0
Requires-Dist: pandera==0.22.1
Requires-Dist: iduedu==0.2.2
Provides-Extra: dev
Requires-Dist: black[jupyter]==22.3; extra == "dev"
Requires-Dist: mapclassify==2.6.1; extra == "dev"
Requires-Dist: folium==0.14.0; extra == "dev"
Requires-Dist: matplotlib-inline==0.1.6; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: ipywidgets; extra == "dev"
Requires-Dist: isort==5.10.1; extra == "dev"
Requires-Dist: pylint==2.17.5; extra == "dev"
Requires-Dist: pre-commit>=3.1; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest<8.0.0,>=7.0.0; extra == "test"
Requires-Dist: pytest-cov<5.0.0,>=4.0.0; extra == "test"
Provides-Extra: docs
Requires-Dist: docutils<0.20,>=0.18.1; extra == "docs"
Requires-Dist: sphinx==6.2.1; extra == "docs"
Requires-Dist: sphinx-book-theme==1.0.1; extra == "docs"
Requires-Dist: nbsphinx==0.9.3; extra == "docs"
Requires-Dist: nbsphinx-link==1.3.0; extra == "docs"
Requires-Dist: numpydoc==1.5.0; extra == "docs"
Requires-Dist: autodocsumm==0.2.12; extra == "docs"
Requires-Dist: myst_parser<4.0.0,>=3.0.0; extra == "docs"
Requires-Dist: sphinx_rtd_theme<2.0.0,>=1.2.0; extra == "docs"
Requires-Dist: pandoc<3.0.0,>=2.0.0; extra == "docs"
Requires-Dist: readme_renderer<44.0; extra == "docs"

Python package boilerplate (IDU) 
================================

.. logo-start

.. figure:: https://sun9-46.userapi.com/impf/aUFBStH0x_6jN9UhgwrKN1WN4hZ9Y2HMMrXT2w/NuzVobaGlZ0.jpg?size=1590x400&quality=95&crop=0,0,1878,472&sign=9d33baa41a86de35d951d4bbd8011994&type=cover_group
   :alt: The Institute of Design and Urban Studies

.. logo-end

|Documentation Status| |PythonVersion| |Black|

.. readme-start 

Installation
------------

The library can be installed with ``pip``:

::

   pip install git+https://github.com/vasilstar97/python-package-boilerplate@main


How to use
----------

Use the library by importing classes from ``my_package``:

::

   from my_package.my_module_1 import MyClass

For more detailed use case see our `examples <#examples>`__.

Data
----

All the required data is stored in `examples
data folder <./examples/data>`__.

Examples
--------

Next examples will help one to get used to the library:

1. Main `example <./examples/my_example.ipynb>`__ of the library.
2. ...

Documentation
-------------

Detailed information and description of the library is available in
`documentation <https://vasilstar97.github.io/python-package-boilerplate/>`__.

Project Structure
-----------------

The latest version of the library is available in the ``main`` branch.

The repository includes the following directories and modules:

-  `my_package <./my_package>`__
   directory with the library code:

   -  ...
   -  ...

-  `tests <./tests>`__
   ``pytest`` testing
-  `examples <./examples>`__
   examples of how the library works
-  `docs <./docs>`__
   documentation sources

Developing
----------

...

License
-------

The project has `BSD-3-Clause license <./LICENSE>`__

Acknowledgments
---------------

...

Contacts
--------

You can contact me:

-  `Vasilii Starikov <https://t.me/vasilstar>`__ - assistant

Also, you are welcomed to the `issues <./issues>`__ section!

Publications
------------

-  `My publication name from scholar or something <https://scholar.google.com/>`__
-  ...

.. |Documentation Status| image:: https://github.com/vasilstar97/python-package-boilerplate/actions/workflows/documentation.yml/badge.svg?branch=main
   :target: https://vasilstar97.github.io/python-package-boilerplate/
.. |PythonVersion| image:: https://img.shields.io/badge/python-3.10-blue
   :target: https://pypi.org/project/geopandas/
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black

.. readme-end
