Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce dependencies #71

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Reduce dependencies #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,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]`.)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this expected to work?

Suggested change
(or, if you cloned the repository, `pip install -e[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
View file
Open in desktop
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.0.1"]
dev = ["changelist == 0.5"]

Expand Down