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

Packaging Support #18

Open
egeKeyvan opened this issue Dec 22, 2023 · 4 comments
Open

Packaging Support #18

egeKeyvan opened this issue Dec 22, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@egeKeyvan
Copy link

Thanks for the great work with this library. I have a feature request though.

Currently, in order to find the other files in the project, you add them to the path manually. This is not a good practice in general and leads to several problems. One of them is I am not able to get any Language Server completions since LSP can't recognize the path additions. This makes navigating the code much harder. Also, with this hardcoded addition, the library cannot be installed and used with other libraries. For example, if I had a different mapper than NDT, i can't use it with the existing code easily without making additions to your library as well which would make it difficult to keep up with the newer Github releases.

My suggestion is to package the project using pyproject.toml so that library users can install this to their machine and get full LSP support and flexibility in adding additional stuff.

One more suggestion is also use a linter and formatter such as ruff. It would greatly help in organizing the imports, enforce good code and provide better readibility.

If you are open to it, I can add pyproject support with tooling.

@ShisatoYano ShisatoYano added the enhancement New feature or request label Dec 23, 2023
@ShisatoYano
Copy link
Owner

Hi, @egeKeyvan. Thank you for suggesting the good improvement idea!!
This is the first opened issue for my project, I'm so glad!!

I want to ask you to add pyproject support and send me a pull request, but a document about how to contribute to this project has not been prepared well yet. So, I will add by myself this time.

I will let you know here after I could add.
Thank you for your suggestion again!!

@egeKeyvan
Copy link
Author

Great, thanks for the effort on improving the library! Please let me know if there is anything you need help with. Also, please consider having a publication list for referencing in case this work is useful in academic context

@egeKeyvan
Copy link
Author

Hi, Do you have any updates with this ?

@ShisatoYano
Copy link
Owner

I've been doing but not completed yet because I have been so busy these days.
Please for a while more.

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

No branches or pull requests

2 participants