diff --git a/README.md b/README.md index 014e542..1dde79e 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,21 @@ The command will collect information from GitHub and generate two output files i `packagename_issues.json`: this file contains information about issues for the repository of interest. `packagename_PRs.json`: this file contains information associated with pull requests for the repository of interest. +## Publish command + +The `publish` command can be used to generate a report website, such +as https://devstats.scientific-python.org, from the downloaded data. + +This functionality is still under heavy development. + +To try it out, first install the publishing dependencies. + +``` +pip install "devstats[publish]" +``` + +(or, if you cloned the repository, `pip install -e ".[publish]"`.) + ## Development instructions If you wish to contribute to devstats: diff --git a/pyproject.toml b/pyproject.toml index d0de3f1..2c9c8a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ version = "0.2rc0.dev0" requires-python = ">=3.8" description = "Developer tool for scientific Python libraries" license = {file = "LICENSE"} -readme = "tREADME.md" +readme = "README.md" maintainers = [ {name = "Scientific Python", email = "devstats@discuss.scientific-python.org"} ] @@ -19,16 +19,18 @@ classifiers = [ dependencies = [ "click", "requests", - "jupyter", - "notebook", - "numpy", - "networkx", ] [project.scripts] devstats = "devstats.__main__:cli" [project.optional-dependencies] +publish = [ + "jupyter", + "notebook", + "numpy", + "networkx" +] lint = ["pre-commit == 4.2.0"] dev = ["changelist == 0.5"]