Merge pull request #7 from FabricioArendTorres/devel

Devel

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+branch = True
+omit =
+    streamauc/metrics/metric_synonyms.py

.gitignore

@@ -130,3 +130,6 @@ dmypy.json
 
 # templates
 .github/templates/*
+
+
+.idea

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # How to develop on this project
 
-streamauc welcomes contributions from the community.
+streamAUC welcomes contributions from the community.
 
 **You need PYTHON3!**
 
@@ -90,24 +90,3 @@ docs:             ## Build the documentation.
 switch-to-poetry: ## Switch to poetry package manager.
 init:             ## Initialize the project based on an application template.
 ```
-
-## Making a new release
-
-This project uses [semantic versioning](https://semver.org/) and tags releases with `X.Y.Z`
-Every time a new tag is created and pushed to the remote repo, github actions will
-automatically create a new release on github and trigger a release on PyPI.
-
-For this to work you need to setup a secret called `PIPY_API_TOKEN` on the project settings>secrets, 
-this token can be generated on [pypi.org](https://pypi.org/account/).
-
-To trigger a new release all you need to do is.
-
-1. If you have changes to add to the repo
-    * Make your changes following the steps described above.
-    * Commit your changes following the [conventional git commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
-2. Run the tests to ensure everything is working.
-4. Run `make release` to create a new tag and push it to the remote repo.
-
-the `make release` will ask you the version number to create the tag, ex: type `0.1.1` when you are asked.
-
-> **CAUTION**:  The make release will change local changelog files and commit all the unstaged changes you have.

Makefile

@@ -32,10 +32,9 @@ fmt:              ## Format code using black & isort.
 
 .PHONY: lint
 lint:             ## Run pep8, black, mypy linters.
-	$(ENV_PREFIX)flake8 streamauc/
+	$(ENV_PREFIX)flake8 --per-file-ignores="__init__.py:F401"  streamauc/
 	$(ENV_PREFIX)black -l 79 --check streamauc/
 	$(ENV_PREFIX)black -l 79 --check tests/
-	$(ENV_PREFIX)mypy --ignore-missing-imports streamauc/
 
 .PHONY: test
 test: lint        ## Run tests and generate coverage report.
@@ -90,7 +89,8 @@ release:          ## Create a new tag for release.
 .PHONY: docs
 docs:             ## Build the documentation.
 	@echo "building documentation ..."
-	@$(ENV_PREFIX)mkdocs build
+	@$(ENV_PREFIX)pdoc3 streamauc -o site/ --html --force -c latex_math=True
+	@mv site/streamauc/* site
 	URL="site/index.html"; xdg-open $$URL || sensible-browser $$URL || x-www-browser $$URL || gnome-open $$URL || open $$URL
 
 .PHONY: switch-to-poetry