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

fix packaging and md syntax issues #469

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

wiseaidev
Copy link

@wiseaidev wiseaidev commented Nov 15, 2022

High Level Overview of Change

  • Made the package pep-561 compatible by Including the root py.typed file in the package.
  • Removed redundant py.typed files.
  • Updated poetry and poetry-core.
  • Fixed markdown syntax.
  • Fixed a flake8 issue.
  • Removed an unnecessary MANIFEST.in file.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (You added tests for code that already exists, or your new feature included in this PR)
  • Documentation Updates
  • Release

Test Plan

I haven't tested these changes yet. I will be working on it later, or you can trigger the CI.

Context

Note that the new version of poetry introduced new arguments like --group. For example, you can run the following commands to:

  • Install the main dependencies only:
poetry install --only main
  • Install the dev dependencies:
poetry install --only dev
  • Add a new dependency to dev:
poetry add pytest --group dev
  • Add a new dependency to main:
poetry add requests

You can refer to python-poetry.org/docs/cli for more info.

Signed-off-by: wiseaidev <[email protected]>
@mvadari
Copy link
Collaborator

mvadari commented Nov 15, 2022

Will removing all the individual py.typed in individual folders support the syntax of from xrpl.models import ...?

@wiseaidev wiseaidev marked this pull request as draft November 16, 2022 09:04
@JST5000
Copy link
Contributor

JST5000 commented May 24, 2023

@wiseaidev Do you happen to know an answer to mvadari's question about whether this will still allow for individual files to be imported with types?

@@ -19,7 +19,7 @@ python-versions = "*"

[[package]]
name = "anyio"
version = "3.6.1"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please avoid running poetry update in this PR so that we don't have issues with dependencies.

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