You can install Taswira by creating a Conda environment using the included environment.yml file. This arrangement allows a cross-platform way for setting up the development environment.
This will be a little too complicated for people who want to use the tool and do not need to setup a development environment.
In this document, I propose that we should upload the tool on PyPI so that users can install by running:
$ pip install taswira
PyPI
The Python Package Index (PyPI) is a repository of software written in Python. It functions as the primary source for pip which is a package installer that by default ships with all modern distributions of Python.
The above descriptions makes PyPI that perfect place to publish our project at.
Flit
setuptools is the most popular method for packaging Python packages. It's great but requires a lot of complicated configuration. Flit is much more easier to configure as is supports the modern pyproject.toml package specification format.
Why Restructure Repository?
PyPI uses the repository's README on a project's page in its website. This is why I would need to change the README to describe the tool and would need to remove the GSoC information.
At the moment the tool is present in a sub-directory labelled taswira, I would need to move the contents of that sub-directory to the root of the repo. I would also like to change the repository's name to taswira and set its description to "An interactive visualisation tool for GCBM output". This will help increase the visibility of the tool and allow people to find it easily.
You can install Taswira by creating a Conda environment using the included
environment.ymlfile. This arrangement allows a cross-platform way for setting up the development environment.This will be a little too complicated for people who want to use the tool and do not need to setup a development environment.
In this document, I propose that we should upload the tool on PyPI so that users can install by running:
PyPI
The Python Package Index (PyPI) is a repository of software written in Python. It functions as the primary source for
pipwhich is a package installer that by default ships with all modern distributions of Python.The above descriptions makes PyPI that perfect place to publish our project at.
Flit
setuptools is the most popular method for packaging Python packages. It's great but requires a lot of complicated configuration. Flit is much more easier to configure as is supports the modern pyproject.toml package specification format.
Why Restructure Repository?
PyPI uses the repository's README on a project's page in its website. This is why I would need to change the README to describe the tool and would need to remove the GSoC information.
At the moment the tool is present in a sub-directory labelled
taswira, I would need to move the contents of that sub-directory to the root of the repo. I would also like to change the repository's name totaswiraand set its description to "An interactive visualisation tool for GCBM output". This will help increase the visibility of the tool and allow people to find it easily.