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.

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

Update Python README #563

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Update Python README #563

merged 2 commits into from
Jan 31, 2024

Conversation

tangowithfoxtrot
Copy link
Contributor

Type of change

Fix errors in README and update the Python package name in preparation for publishing to PyPI.

  • Bug fix
  • New feature development
  • Tech debt (refactoring, code cleanup, dependency upgrades, etc)
  • Build/deploy pipeline (DevOps)
  • Other

Before you submit

  • Please add unit tests where it makes sense to do so

@tangowithfoxtrot tangowithfoxtrot requested a review from a team January 30, 2024 15:12
@tangowithfoxtrot
Copy link
Contributor Author

I spoke with @maxkpower about #530. We are going to leave the pip install step in, since the Python package should be published soon.

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3064ac5) 51.65% compared to head (707fa62) 51.65%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #563   +/-   ##
=======================================
  Coverage   51.65%   51.65%           
=======================================
  Files         163      163           
  Lines        8202     8202           
=======================================
  Hits         4237     4237           
  Misses       3965     3965           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tangowithfoxtrot tangowithfoxtrot changed the title update pip package name, add import example, correct maturin install Update Python README Jan 30, 2024
Copy link
Contributor

@Thomas-Avery Thomas-Avery left a comment

Choose a reason for hiding this comment

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

LGTM

@tangowithfoxtrot tangowithfoxtrot enabled auto-merge (squash) January 30, 2024 19:46
@bitwarden-bot
Copy link

bitwarden-bot commented Jan 30, 2024

Logo
Checkmarx One – Scan Summary & Details5499dedf-4130-4e63-aa50-2ce50436cd9c

No New Or Fixed Issues Found

@tangowithfoxtrot tangowithfoxtrot merged commit 872a05b into main Jan 31, 2024
41 of 42 checks passed
@tangowithfoxtrot tangowithfoxtrot deleted the update-python-readme branch January 31, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants