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

Adding git-cliff to PyPI #150

Closed
radusuciu opened this issue Mar 31, 2023 · 7 comments · Fixed by #158
Closed

Adding git-cliff to PyPI #150

radusuciu opened this issue Mar 31, 2023 · 7 comments · Fixed by #158
Assignees
Labels
feature/request New feature or request

Comments

@radusuciu
Copy link
Contributor

Is your feature request related to a problem? Please describe.
This is similar in scope to the feature described in #133 and implemented in #134. This would make it seamless for Python projects to install and use git-cliff and would pair nicely with the newly added support for configuration in pyproject.toml. It also fits nicely in the recent rustification of python tooling trend.

Describe the solution you'd like
The approach you described in your blog post for npm can be adapted for PyPI. I think the best approach would be to use maturin. For an example, you can check out this workflow in the ruff project.

I'm willing to take a shot at a PR if you're interested in adding this feature. Thanks!

@orhun
Copy link
Owner

orhun commented Mar 31, 2023

Hello @radusuciu! 🐻

I have been already thinking about this but couldn't find the time to properly implement it. The way that you described seems feasible to me and it would be absolutely great to have git-cliff on PyPI.

One example project to look at is typos which has a PyPI package. It also has a similar implementation.

I'm willing to take a shot at a PR if you're interested in adding this feature. Thanks!

Please do!

@radusuciu
Copy link
Contributor Author

radusuciu commented Mar 31, 2023

Alright, I'll give it a shot and thank you for sharing typos example!

Found a link to this blog in the typos issue for that change that I wanted to note down here: https://simonwillison.net/2022/May/23/bundling-binary-tools-in-python-wheels/

@orhun
Copy link
Owner

orhun commented Apr 1, 2023

Great, I'll look forward to it!

@orhun orhun added the feature/request New feature or request label Apr 2, 2023
@orhun
Copy link
Owner

orhun commented Apr 10, 2023

Hey @radusuciu, I was wondering if you're still interested. I can assign the issue to you if you're planning to work on it :3

@radusuciu
Copy link
Contributor Author

Hey @radusuciu, I was wondering if you're still interested. I can assign the issue to you if you're planning to work on it :3

I am still interested but this week is very busy with work/life so I cannot work on it. You can go ahead and assign it to me however. The reason I'd like to have this feature is because I want to use git-cliff in more python projects and having it on PyPI makes this way smoother, so I am definitely motivated :)

@orhun orhun assigned radusuciu and unassigned orhun Apr 13, 2023
@orhun
Copy link
Owner

orhun commented Apr 13, 2023

Awesome, just wanted to let you know that the documentation is moved to docs/ and live on https://git-cliff.org

You can simply create installation/python.md for updating the documentation 🐻

@orhun
Copy link
Owner

orhun commented Apr 19, 2023

Another interesting thing would be building musl wheels: crate-ci/typos@54042f2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants