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

feat: restructure code as Python package 📦 #22

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

lxndrblz
Copy link
Contributor

Hello Alex,

in this PR I propose a slight refactoring of the project setup that allows to use the code as a Python module.

This has two main benefits:

  1. The library could be distributed through the Python Package Index (PyPi).
  2. Otherwise, it's possible to add your repo as a dependency to an existing project and simply update it whenever something changes in the CCL library.

For option 2, the git repo could simply be added as a dependency in the pyproject.toml:

dependencies = [
"chromedb @ git+https://github.com/cclgroupltd/ccl_chrome_indexeddb/@master",
]

Please let me know what you think.

@cclgroupltd
Copy link
Owner

Hi, thanks for this. Let me sit with this for a couple of days because I'm wondering if this is an opportunity to fix a "problem" with this module - i.e. the level_db support (and its dependencies) probably should live outside of what is otherwise a specifically Chrome focussed module, given that it is used much more widely than just Chrome.

My concern there is that might be a breaking change too far for folks who are already using the libraries in other projects (although this change will require at least some changes to other users' code I suppose).

As this is your PR, I'd welcome your views of course.

@lxndrblz
Copy link
Contributor Author

@cclgroupltd That makes perfect sense.

The reason why I had proposed this change, was because I found it rather hard to integrate the repo in one of my projects, without copying the code. However, I also understand your point that it would inadvertently lead to some breaking changes for current users. Unfortunately, I don't have a solution for that problem yet, but I'll give it some thought.

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 this pull request may close these issues.

None yet

2 participants