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

Add packaging information #1

Open
exhuma opened this issue Jun 21, 2021 · 5 comments
Open

Add packaging information #1

exhuma opened this issue Jun 21, 2021 · 5 comments

Comments

@exhuma
Copy link
Contributor

exhuma commented Jun 21, 2021

It would be convenient to have packaging information in this project. This would make it possible to publish it on pypi, and consequently make it easier to install.

I have a fair amount of experience in this and would be willing to add a PR. Let me know if you'd be interested in working on a PR.

I could also provide a github-actions based pipeline which could automatically publish (see https://github.com/exhuma/x690/actions/runs/927851913 for an example what this would look like).

Packaging meta-data and GitHub actions could be two separate PRs or one, whichever you prefer.

@srijan
Copy link
Owner

srijan commented Jun 21, 2021

Thanks for your interest.

I think packaging + README update for usage instructions in one PR, and github actions in a separate PR.

@exhuma
Copy link
Contributor Author

exhuma commented Jun 23, 2021

Alright then. I will also move things into a package and add a real console entry-point for it.

In my experience this is going to be beneficial down the road. Especially if there's a need to further split the project into more modules. Having a package-structure gives more freedom, without impacting the way users will see the script.

Except with this first change by adding the entry-point.

I will do aggressive changes on this (with that I mean I will introduce some backwards-incompatibility). Once the PR is in, let me know what you think.

@exhuma exhuma mentioned this issue Jun 23, 2021
@exhuma
Copy link
Contributor Author

exhuma commented Jun 28, 2021

Let me know if you have any feedback. I'll wait until this is merged until I'll tackle the github-actions.

@srijan
Copy link
Owner

srijan commented Jul 6, 2021

@exhuma, what are your thoughts on a better name for this project to upload on pypi?

Looking at this,
image

I'm thinking telegraf-pgcustom or telegraf-pgquery.

@exhuma
Copy link
Contributor Author

exhuma commented Jul 8, 2021

I think both are fine actually.

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

No branches or pull requests

2 participants