test-template

https://github.com/zilinghan/test-template

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
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: Zilinghan
License: mit
Language: Python
Default Branch: main
Size: 258 KB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 2
Releases: 0

Created over 1 year ago · Last pushed 10 months ago

Metadata Files

Readme Contributing License Code of conduct Citation Security

Python Package Template Repo

Python package template repo that provides: - Package, examples, and testing layout. - GitHub PR and Issue templates. - Example docs with MKDocs and GitHub Pages. - CI framework with pre-commit and tox. - GitHub actions for running tests and publishing packages.

This package setup was based on Anthony Sottile's project setup but deviates in some places (e.g., pyproject.toml and ruff).

Setup Instructions

Click the "Use this template" button at the top right of this page.
Delete and directories you will not be using (commonly docs/ if you do not want to use MKDocs or examples/ if you will not have example code).
Follow the instructions to create the new repo then clone your repo locally.
The template uses "foobar1" to indicate things that need to be changed. Start by searching for all instances (git grep foobar1) and changing them accordingly.
Configure pre-commit:
- Go to https://pre-commit.ci/ and enable pre-commit on your repo.
- Update the pre-commit badge URL in this README with your new badge URL.
Configure GitHub pages:
- Go to the "Pages" section of your repository settings.
- Select "Deploy from a branch" and use the "gh-pages" branch.
Configure PyPI releases (if relevant):
- Create a new API token for https://pypi.org/.
- Add the token as a GitHub actions secret (see the instructions here).
Delete this boilerplate stuff in the README.
Commit and push changes.

GitHub Configuration

I recommend making a few other changes to the repo's setting on GitHub. - In "General" - Select/deselect features you need/don't need. - Select "Automatically delete head branches - In "Branches": enable branch protection on main. - Check "Require a pull request before merging" - Check "Require status checks to pass before merging" - Check "Require branches to be up to date before merging" - Set required checks (e.g., pre-commit.ci, tests, etc.) - Check "Do not allow bypassing the above settings"

Installation

Install via pip: $ pip install foobar1

For local development: $ tox --devenv venv -e py310 $ pre-commit install or $ pip install -e .

Additional README Sections

...

Owner

Name: Zilinghan Li
Login: Zilinghan
Kind: user
Location: Champaign, IL
Company: CS@UIUC

Website: Zilinghan.github.io
Repositories: 4
Profile: https://github.com/Zilinghan

MSCS @ UIUC | Researcher @ NCSA | Visiting Student @ Argonne National Lab | Incoming Intern @ Amazon Web Services

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it as below.
authors:
  - family-names: Pauloski
    given-names: Greg
    orcid: https://orcid.org/0000-0002-6547-6902
license: MIT
repository-code: https://github.com/foobar1-author/foobar1
title: foobar1
url: https://foobar1.dev

GitHub Events

Total

Push event: 44
Public event: 1
Pull request review event: 5
Pull request event: 24
Create event: 2

Last Year

Push event: 44
Public event: 1
Pull request review event: 5
Pull request event: 24
Create event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 0
Total pull requests: 8
Average time to close issues: N/A
Average time to close pull requests: 1 day
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 8

Past Year

Issues: 0
Pull requests: 8
Average time to close issues: N/A
Average time to close pull requests: 1 day
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 8

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science