Skip to content

Commit

Permalink
Add docs config
Browse files Browse the repository at this point in the history
Update setup remove ipympl dependency
Update Project Name
add build to Makefile
  • Loading branch information
rmontanana committed May 11, 2021
1 parent 79190ef commit d46f544
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 11 deletions.
6 changes: 5 additions & 1 deletion Makefile
@@ -1,6 +1,6 @@
SHELL := /bin/bash
.DEFAULT_GOAL := help
.PHONY: coverage deps help lint push test
.PHONY: coverage deps help lint push test doc build

coverage: ## Run tests with coverage
coverage erase
Expand All @@ -24,6 +24,10 @@ test: ## Run tests
doc: ## Update documentation
make -C docs --makefile=Makefile html

build: ## Build package
rm -fr dist/*
python setup.py sdist bdist_wheel

doc-clean: ## Update documentation
make -C docs --makefile=Makefile clean

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -3,7 +3,7 @@
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/35fa3dfd53a24a339344b33d9f9f2f3d)](https://www.codacy.com/gh/Doctorado-ML/STree?utm_source=github.com&utm_medium=referral&utm_content=Doctorado-ML/STree&utm_campaign=Badge_Grade)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/Doctorado-ML/STree.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Doctorado-ML/STree/context:python)

# Stree
# STree

Oblique Tree classifier based on SVM nodes. The nodes are built and splitted with sklearn SVC models. Stree is a sklearn estimator and can be integrated in pipelines, grid searches, etc.

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
@@ -1,3 +1,4 @@
sphinx
sphinx-rtd-theme
myst-parser
git+https://github.com/doctorado-ml/stree
2 changes: 1 addition & 1 deletion docs/source/stree.md
@@ -1,4 +1,4 @@
# Stree
# STree

[![Codeship Status for Doctorado-ML/STree](https://app.codeship.com/projects/8b2bd350-8a1b-0138-5f2c-3ad36f3eb318/status?branch=master)](https://app.codeship.com/projects/399170)
[![codecov](https://codecov.io/gh/doctorado-ml/stree/branch/master/graph/badge.svg)](https://codecov.io/gh/doctorado-ml/stree)
Expand Down
27 changes: 19 additions & 8 deletions setup.py
@@ -1,17 +1,28 @@
import setuptools
import stree


def readme():
with open("README.md") as f:
return f.read()


VERSION = stree.__version__
def get_data(field):
item = ""
with open("stree/__init__.py") as f:
for line in f.readlines():
if line.startswith(f"__{field}__"):
delim = '"' if '"' in line else "'"
item = line.split(delim)[1]
break
else:
raise RuntimeError(f"Unable to find {field} string.")
return item


setuptools.setup(
name="STree",
version=stree.__version__,
license=stree.__license__,
version=get_data("version"),
license=get_data("license"),
description="Oblique decision tree with svm nodes",
long_description=readme(),
long_description_content_type="text/markdown",
Expand All @@ -21,19 +32,19 @@ def readme():
"Code": "https://github.com/Doctorado-ML/STree",
"Documentation": "https://stree.readthedocs.io/en/latest/index.html",
},
author=stree.__author__,
author_email=stree.__author_email__,
author=get_data("author"),
author_email=get_data("author_email"),
keywords="scikit-learn oblique-classifier oblique-decision-tree decision-\
tree svm svc",
classifiers=[
"Development Status :: 5 - Production/Stable",
"License :: OSI Approved :: " + stree.__license__,
"License :: OSI Approved :: " + get_data("license"),
"Programming Language :: Python :: 3.8",
"Natural Language :: English",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Intended Audience :: Science/Research",
],
install_requires=["scikit-learn", "numpy", "ipympl"],
install_requires=["scikit-learn", "numpy"],
test_suite="stree.tests",
zip_safe=False,
)
10 changes: 10 additions & 0 deletions stree/.readthedocs.yaml
@@ -0,0 +1,10 @@
version: 2

sphinx:
configuration: docs/source/conf.py

python:
version: 3.8
install:
- requirements: requirements.txt
- requirements: docs/requirements.txt

0 comments on commit d46f544

Please sign in to comment.