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

Jump to bottom

Task: Update package metadata. #56

Open
7 of 12 tasks
Asanto32 opened this issue Jul 5, 2024 · 0 comments
Open
7 of 12 tasks

Task: Update package metadata. #56

Asanto32 opened this issue Jul 5, 2024 · 0 comments
Assignees
@Asanto32
Labels
task A development task intended for Github Projects
Milestone
Public Release

Comments

@Asanto32
Copy link
Collaborator

Asanto32 commented Jul 5, 2024 •
edited
Loading

Description

The wristpy readme should be updated to match the content and style of other CMI public repos.

Tasks

  • Update readme to include:
    • Description
    • Installation guide
    • Example usage
  • Add tutorial
  • Update pyproject.toml to accurately reflect package metadata (e.g. authors, description, etcetera...)
  • Update actfast version for idle_sleep_mode metadata support
  • Add Ruff rule INP001 (or just all INP, only 001 exists). This will ensure we have a __init__.py in every subdirectory.
  • Update the SECURITY.md
  • Update the CODE_OF_CONDUCT.md
  • Add citation + zenodo DOI
  • Update activity thresholds + reference in analytics.py

Freeform Notes

Other sections may also be included, this is a short list and summary.
@Asanto32 Asanto32 added the task A development task intended for Github Projects label Jul 5, 2024
@Asanto32 Asanto32 self-assigned this Jul 10, 2024
@ReinderVosDeWael ReinderVosDeWael added this to the Public Release milestone Jul 24, 2024
@ReinderVosDeWael ReinderVosDeWael changed the title Task: Update readme prior to publishing 0.0.1alpha Task: Update package metadata. Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Asanto32 Asanto32

Labels
task A development task intended for Github Projects
Projects
None yet
Milestone
Public Release
Development

No branches or pull requests
2 participants
@ReinderVosDeWael @Asanto32