Metadata-Version: 2.1
Name: mots
Version: 0.0.1.dev0
Summary: Module Ownership in Tree System
Home-page: https://github.com/mozilla-conduit/mots
Author: Zeid Zabaneh
Author-email: zeid@mozilla.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS

Development environment
-----------------------
To set up a local development environment, run the following commands. Replace the python version with the desired version on your local machine.

.. code-block:: bash

    make dev-env PY=python3.9
    source .mots-env/bin/activate
    make dev

The above commands will set up a local development environment using the provided python version available on your machine, and subsequently install all required packages in that environment.

Generate coverage report
------------------------

To generate a standard coverage report, run:

.. code-block:: bash

	make cov

To generate an html coverage report, run:

.. code-block:: bash

	make cov-html
	make serve-cov

Then navigate to your web browser.

Other make commands
-------------------
Run `make` to see all available commands.

.. code-block:: bash

	usage: make <target>

	target is one of:
		help          show this message and exit
		build         build the python package and wheels
		clean         remove temporary files
		cov           run coverage check
		cov-html      generate html coverage report
		dev           setup local dev environment by installing required packages, etc.
		dev-env       create a python virtual environment in ./mots-env
		docs          generate documentation
		requirements  regenerate requirements.txt
		serve-cov     simple http server for coverage report
		serve-docs    simple http server for docs
		test          run the test suite


