Skip to content

migrate from direct API usage to SDK #29

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

Merged
merged 5 commits into from
Nov 5, 2024
Merged

migrate from direct API usage to SDK #29

merged 5 commits into from
Nov 5, 2024

Conversation

flowstate
Copy link
Contributor

Changes

  • Migrated all the direct calls to the API to instead use the python SDK
  • Slight refactor of the Core class to explicitly make it a static class instead of mixing static and instance variables / state
  • Added the dev dependency Ruff, a modern, more performant language server and linter
  • Added python-dotenv and some config for setting up a .env.local file for setting env vars

I've attempted to thoroughly test these changes, but given how new I am to the codebase and company, I'd love a sanity check

@flowstate flowstate requested a review from dacoburn November 1, 2024 01:22
@flowstate flowstate requested a review from a team as a code owner November 1, 2024 01:22
@flowstate flowstate requested review from bcomnes and alxhotel and removed request for a team November 1, 2024 01:22
Copy link

socket-security bot commented Nov 1, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
pypi/oss@0.1.3 eval, filesystem, network 0 149 kB chrisjin
pypi/python-dotenv@1.0.1 environment, eval, filesystem, shell Transitive: network, unsafe +754 3.87 GB bbc, theskumar
pypi/ruff@0.7.2 None 0 0 B
pypi/sca@0.0.1 None 0 6.48 kB dochi
pypi/security@1.3.1 environment, eval, filesystem, network, shell 0 145 kB clavedeluna, pixee
pypi/socketsecurity@1.0.32 environment, eval, filesystem, network 0 17.6 MB dacoburn, feross

View full report↗︎

Copy link

socket-security bot commented Nov 1, 2024

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: pypi/sca@0.0.1, pypi/oss@0.1.3, pypi/oss@0.1.3

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

Copy link

socket-security-staging bot commented Nov 1, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
pypi/oss@0.1.3 eval, filesystem, network 0 149 kB chrisjin
pypi/python-dotenv@1.0.1 environment, eval, filesystem, shell Transitive: network, unsafe +721 3.09 GB bbc, theskumar
pypi/ruff@0.7.2 None 0 0 B
pypi/sca@0.0.1 None 0 6.48 kB dochi
pypi/security@1.3.1 environment, eval, filesystem, network, shell 0 145 kB clavedeluna, pixee
pypi/socketsecurity@1.0.32 environment, eval, filesystem, network 0 17.6 MB dacoburn, feross

View full report↗︎

Copy link

socket-security-staging bot commented Nov 1, 2024

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: pypi/sca@0.0.1, pypi/oss@0.1.3, pypi/oss@0.1.3

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

@flowstate
Copy link
Contributor Author

@SocketSecurity ignore pypi/sca@0.0.1 pypi/oss@0.1.3

ignoring the Staging Alerts due to the incorrect parsing of the pyproject.toml

@flowstate flowstate merged commit 978ea47 into main Nov 5, 2024
4 checks passed
flowstate added a commit that referenced this pull request Nov 6, 2024
flowstate added a commit that referenced this pull request Nov 6, 2024
@dacoburn dacoburn deleted the eric/use-sdk branch April 3, 2025 20:41
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.

2 participants