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

Rename this repo and python package #10

Closed
5 of 6 tasks
mahenzon opened this issue Apr 21, 2020 · 5 comments · Fixed by #15
Closed
5 of 6 tasks

Rename this repo and python package #10

mahenzon opened this issue Apr 21, 2020 · 5 comments · Fixed by #15
Assignees

Comments

@mahenzon
Copy link
Collaborator

mahenzon commented Apr 21, 2020

Rename repo from flask-rest-jsonapi so that it's easier to search and/or allows it to be added to the JSON:API site as a separate project? In addition it makes it clearer to users that it's not the exact same project, especially in case this API diverges from upstream.

UPD: new name will be flask-combo-jsonapi

Flow:

  • create a separate branch for renaming all imports and other names

  • do the same in combojsonapi

  • refactor our production to use new name

  • run tests

  • merge that branch:

    1. merge to master, tag 1.0.0
    2. rename repo
    3. update requirement in combojsonapi
    4. release combojsonapi @1.0.0
  • deploy to pypi Deploy to pypi #11

@Znbiz
Copy link
Contributor

Znbiz commented Apr 21, 2020

I propose to rename it to flask-combo-jsonapi
JSON:API on steroids

@mahenzon
Copy link
Collaborator Author

Here's a thing: our production depends on this repo.
So, the way to implement this rename is:

  • create a separate branch for renaming all imports and other names
  • refactor our production to use new name
  • run tests
  • merge that branch
  • deploy to pypi Deploy to pypi #11
  • change dependency in our production
  • run tests again, deploy

@multimeric
Copy link

In the short term you can rename the repo but not the python module I would hope? Which would give you most of the above advantages without breaking production.

@mahenzon
Copy link
Collaborator Author

mahenzon commented Apr 22, 2020

Yeah. Anyway the work is already done. Waiting for the last manual testing. Renaming the package in the production was the easiest part.
The changes will be merged to develop and master in a day or so

@mahenzon
Copy link
Collaborator Author

Version 1.0.0 released https://github.com/AdCombo/flask-combo-jsonapi/releases/tag/1.0.0

Pending publish to pypi

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 a pull request may close this issue.

4 participants