frgfm/validate-python-headers
An action to validate the headers of your Python files
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.2%) to scientific vocabulary
Keywords
Repository
An action to validate the headers of your Python files
Basic Info
Statistics
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
- Releases: 6
Topics
Metadata Files
README.md
Header validator for your Python files
This action checks the copyright and license notices in the headers of your Python files.
Inputs
owner
Required The copyright owner.
starting-year
Required The starting year of your project.
license
Identifier of the license for your project (cf. SPDX identifiers). Default null.
folders
The folders to inspect, separated by a comma. Default ".".
ignore-files
The files to ignore, separated by a comma. Default "__init__.py".
ignore-folders
The folders to ignore, separated by a comma. Default ".github/".
license-notice
The path to a license notice text. If license is null, the header will be expected to have this text as a license notice. Default null.
Outputs
The list of files with header issues and the suggested format (cf. example below): ``` Your header should look like:
Copyright (C) , Pyronear.
This program is licensed under the Apache License 2.0.
```
Example usages
Using an Open-source license:
uses: frgfm/validate-python-headers@main
with:
license: 'Apache-2.0'
owner: 'François-Guillaume Fernandez'
starting-year: 2022
ignore-files: 'version.py,__init__.py'
ignore-folders: '.github/'
On closed source code:
uses: frgfm/validate-python-headers@main
with:
license-notice: '.github/license-notice.txt'
owner: 'François-Guillaume Fernandez'
starting-year: 2022
ignore-files: 'version.py,__init__.py'
ignore-folders: '.github/'
Contributing
Any sort of contribution is greatly appreciated!
You can find a short guide in CONTRIBUTING to help grow this project!
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Owner
- Name: F-G Fernandez
- Login: frgfm
- Kind: user
- Location: Paris, FR
- Company: @relaycli @pyronear
- Website: https://relaycli.com/manifesto
- Twitter: FrG_FM
- Repositories: 55
- Profile: https://github.com/frgfm
Deep Learning Engineer by day, Open Source contributor by night :bat:
Citation (CITATION.cff)
cff-version: 1.2.0 type: software message: "If you use this software in your work, please cite it as below." authors: - family-names: "Fernandez" given-names: "François-Guillaume" title: "Header validator for Python files" date-released: 2022-06-27 url: "https://github.com/frgfm/validate-python-headers"
GitHub Events
Total
- Release event: 1
- Delete event: 10
- Issue comment event: 5
- Push event: 8
- Pull request review event: 1
- Pull request event: 20
- Create event: 11
Last Year
- Release event: 1
- Delete event: 10
- Issue comment event: 5
- Push event: 8
- Pull request review event: 1
- Pull request event: 20
- Create event: 11
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 17
- Total Committers: 1
- Avg Commits per committer: 17.0
- Development Distribution Score (DDS): 0.0
Top Committers
| Name | Commits | |
|---|---|---|
| F-G Fernandez | 2****m | 17 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1
- Total pull requests: 44
- Average time to close issues: 2 days
- Average time to close pull requests: 3 days
- Total issue authors: 1
- Total pull request authors: 2
- Average comments per issue: 2.0
- Average comments per pull request: 0.43
- Merged pull requests: 24
- Bot issues: 0
- Bot pull requests: 24
Past Year
- Issues: 1
- Pull requests: 28
- Average time to close issues: 2 days
- Average time to close pull requests: 4 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 2.0
- Average comments per pull request: 0.68
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 24
Top Authors
Issue Authors
- Nastaliss (1)
Pull Request Authors
- dependabot[bot] (51)
- frgfm (27)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 16
- Total versions: 6
github actions: frgfm/validate-python-headers
Validate the copyright & license references in the headers of your Python files
- License: apache-2.0
-
Latest release: v0.5.1
published about 1 year ago
Rankings
Dependencies
- actions/checkout v2 composite
- satackey/action-docker-layer-caching v0.0.11 composite
- actions/checkout v2 composite
- actions/setup-python v1 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- satackey/action-docker-layer-caching v0.0.11 composite
- Dockerfile * docker
- python 3.8.13-alpine build
- amannn/action-semantic-pull-request v5 composite
- actions/labeler v4 composite
- cfgv 3.4.0
- distlib 0.3.8
- filelock 3.15.4
- identify 2.5.36
- mypy 1.10.0
- mypy-extensions 1.0.0
- nodeenv 1.9.1
- platformdirs 4.2.2
- pre-commit 3.7.1
- pyyaml 6.0.1
- ruff 0.5.1
- tomli 2.0.1
- typing-extensions 4.12.2
- virtualenv 20.26.3
- mypy ==1.10.0 quality
- pre-commit ^3.6.0 quality
- ruff ==0.5.1 quality
- python ^3.9