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

[Feature] Refactor file structure #43

Closed
alepouna opened this issue Feb 4, 2023 · 4 comments · Fixed by #72
Closed

[Feature] Refactor file structure #43

alepouna opened this issue Feb 4, 2023 · 4 comments · Fixed by #72
Labels
ci/cd Issue or PR related to CI/CD code quality This PR improves the code quality of the program enhancement New feature or request

Comments

@alepouna
Copy link
Collaborator

alepouna commented Feb 4, 2023

The project currently has a lot of files that are generally unorganized and messy. They make sense due to proper naming by Poro but we should organize things a little.

Proposing this file structure:

.github/
src/
   # Contains the Python files (Config.py, FarmThread.py, etc) and the pip files (if possible), poro icon, any sound files, etc
config/ 
   # Contains config.json / config.yaml and the 'bestStreams.txt' 
setup/ 
   # Various pre-made setup scripts (for docker, deployment in other hosting services or OSes, as well as 'self build' tools) 
LICENSE
README.md
CONDUCT.md

This isn't the best structure, frankly the current is just fine, but I believe if we can organize the project better and with subfolders, developing and maintaining it will become a piece of cake.

This shouldn't affect the end user as they download the build version anyways, but rather developers that wish to jump in the project, so it's definitely beneficial!

@alepouna alepouna added the enhancement New feature or request label Feb 4, 2023
@LeagueOfPoro
Copy link
Owner

I wanted to do the src folder for a long time and then never got around to doing it. The problem is moving the config to a separate folder would be a breaking change and it would require either specifying --config option or changing the default location.

@alepouna
Copy link
Collaborator Author

alepouna commented Feb 4, 2023

We don't have to require the config file on a different location, the folder is purely to contain the templates. Users will still need to create (or have it prebundled in releases) the config files on the same folders

@alepouna
Copy link
Collaborator Author

alepouna commented Feb 4, 2023

o

To add to this, if it was a Node/NPM project you would be able to just create a command to automatically build it :P I don't know if PIP can do that, but we can just create an bash script for development to automatically build, copy the config template and bundle everything.

@alepouna
Copy link
Collaborator Author

alepouna commented Feb 6, 2023

Closing this issue as completed since PR #72 has been opened.

For contributors: Please rebase your PRs to match the new paths, before submitting them.

@alepouna alepouna closed this as completed Feb 6, 2023
@alepouna alepouna pinned this issue Feb 6, 2023
@alepouna alepouna added critical For issues that need to be check ASAP ci/cd Issue or PR related to CI/CD code quality This PR improves the code quality of the program labels Feb 6, 2023
@LeagueOfPoro LeagueOfPoro removed the critical For issues that need to be check ASAP label Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd Issue or PR related to CI/CD code quality This PR improves the code quality of the program enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants