renalreg / renalreg/.github

More File Checking

Open
#4 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Some other bits which could be added.

If repo is a "library" then there must not be a poetry.lock file.

If repo is a "library" there should be a py.typed file - and (and this seems to have regressed in a few packages) - there needs to be a reference in the pypoetry, manifest or somesuch so the file is bundled with the package. Without this MyPy doesn't work across repos.

While I write, https://github.com/regebro/pyroma seems quite useful for checking other issues with the packaging.

Oh and also...

https://deptry.com/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing file-checking logic in this .github repository and how it identifies Python libraries. Add checks for poetry.lock, py.typed, and packaging metadata that includes py.typed, then verify the checks against the packaging cases described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.