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

WIP - Minor improvements #229

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

abanna
Copy link
Collaborator

@abanna abanna commented May 2, 2024

No description provided.

@abanna abanna changed the title Minor improvements WIP - Minor improvements May 2, 2024
@abanna abanna requested a review from bsherman May 2, 2024 06:26
@abanna abanna added the beta label May 2, 2024
@abanna abanna added this to the 0.0.9-beta1 milestone May 2, 2024
Copy link

@tulilirockz tulilirockz left a comment

Choose a reason for hiding this comment

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

LGTM!

Comment on lines +53 to +63
furo = "*"
myst-parser = "*"
myst-nb = "*"
sphinx = "*"
sphinx-autobuild = "*"
sphinx-autodoc-typehints = "*"
sphinx-copybutton = "*"
sphinxcontrib-mermaid = "*"
sphinxcontrib-napoleon = "*"
sphinx-design = "*"
sphinx-inline-tabs = "*"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't use *, use some version boundaries. Generally, when adding dependencies use poetry add <package> or poetry add --group docs <package> it'll resolve the package and add the latest version tag.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, this needs to be updated thanks for pointing it out. Likely missed as I had all the intention to get GitHub pages up and running with some nice docs.

.python-version Show resolved Hide resolved
Comment on lines +1 to +7
[distutils]
index-servers = forgejo

[forgejo]
repository = https://things.com
username = {username}
password = {password}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure what this file is for

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

local pypi server template. will remove if you want.

Comment on lines +16 to +17
__version__: str = "0.9.0-beta1"
__name__: str = "yafti"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This shouldn't be needed. It's already tracked in the pyproject.toml

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

just personal preference I guess. will remove if you hate it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't hate it, but it means everyone needs to know two places to track version - pyproject.toml has it and should be the source of truth for versions

Copyright 2023 Marco Ceppi
Copyright 2024 Alex Banna
Copy link
Collaborator

Choose a reason for hiding this comment

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

You can keep multiple copyright headers. My copyright doesn't go away because theyre's a new maintainer. Add you name below and the year it started.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

sorry

"""
typer.echo(f"Platform: {sys.platform}")
typer.secho(f"Python Version: {sys.version}")
typer.secho(f"Yafti Version: {__version__}")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

Actually, that is not the best way, Py3 has importlib.metadata.version("yafti") which will do what you want

pyproject.toml Show resolved Hide resolved
@abanna
Copy link
Collaborator Author

abanna commented May 9, 2024

yafti-2024-05-01-00-23-01.webm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants