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

Python variant #42

Open
coatless opened this issue Jan 22, 2024 · 2 comments · May be fixed by #52
Open

Python variant #42

coatless opened this issue Jan 22, 2024 · 2 comments · May be fixed by #52
Labels
priority: medium Medium priority status: planned Planning to implement type: new New feature or enhancement

Comments

@coatless
Copy link
Collaborator

As I'm aiming to close out #27 this week, we probably should discuss how the Python variant should be structured.

Given there are a lot of packaging tools for Python, is there a preference among the tools that should be used? e.g. Build + setuptools, Poetry, Twine, Flit, Hatch, or PDM.

If we're aiming to publish on PyPi's repository, we'll need to rename to py-countdown as countdown is already taken by someone else. Alternatively, we could reach out and ask if they would be okay with letting us re-use the name (not sure how that would work).

For the package layout, I'm thinking about something like:

.
├── LICENSE
├── pyproject.toml
├── README.md
├── src/ 
│   ├── countdown/
│   │   ├── __init__.py
│   │   ├── countdown.py
│   │   └── utils.py
│   └── shiny_app/
│       ├── __init__.py
│       └── app.py
└── tests/
@coatless coatless added status: planned Planning to implement type: new New feature or enhancement priority: medium Medium priority labels Jan 22, 2024
@gadenbuie
Copy link
Owner

gadenbuie commented Jan 22, 2024

Thanks for writing this out. Personally, I'd prefer using build + setuptools for packaging. Simon Willison has a helpful cookiecutter template and a post about his workflow in Python packages with pyproject.toml and nothing else.

If we're aiming to publish on PyPi's repository, we'll need to rename to py-countdown as countdown is already taken by someone else.

That's a bummer. And countdown-timer is also taken. I'm not a huge fan of py-countdown; I'd rather pick a name that makes sense if you saw it out-of-context in PyPI. I'm thinking countdown-widget for the package name, but users would still import the countdown function. It's not my favorite name but I think it makes sense within the Python package ecosystem.

@coatless
Copy link
Collaborator Author

Simon Willison has a helpful cookiecutter template and a post about his workflow in Python packages with pyproject.toml and nothing else.

Oh, nice! I'll aim to use that when spinning up the new project.

I'm thinking countdown-widget for the package name, but users would still import the countdown function.

Okay. Would you like me to try reaching out and asking if the person would be okay with letting us use the name as well? Both projects seem to have stopped updating and I'm not sure of the use.

@coatless coatless linked a pull request Feb 4, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: medium Medium priority status: planned Planning to implement type: new New feature or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants