Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 7 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "[email protected]"}
]
Expand All @@ -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"]

Expand Down