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: Create an executable binary for the CLI #4

Open
akashchouhan16 opened this issue Jul 5, 2023 · 8 comments
Open

🛠️ Feat: Create an executable binary for the CLI #4

akashchouhan16 opened this issue Jul 5, 2023 · 8 comments
Assignees

Comments

@akashchouhan16
Copy link
Collaborator

akashchouhan16 commented Jul 5, 2023

Currently, you'd need to run your project as a Python script. Ideally, CLI tools are better suited to run as executable binary files. There are tools like PyInstaller or p2exe that can help create a binary file for your Python script.

How cli2cloud presently runs on the terminal:

$ python app.py -del file_name

How cli2cloud would runs on the terminal post Change:

$ c2c -del file_name

Note: Taking c2c as an example for this cli tool. You can name it anything.

Once implemented, it'll be much cleaner to set up and use this CLI tool.
@thekaranatic

@thekaranatic
Copy link
Owner

thekaranatic commented Jul 5, 2023

Hi @akashchouhan16 ! So glad you reached out :) Thanks for highlighting the importance of creating a binary file for cli2cloud. I didn't know that it will ease the interaction with CLI in this way. I'll soon begin working on that.
But what about the API key I use? I am concerned: if I include the API key in the source code and publish the package with the same key, would a user be able to access that key?

@akashchouhan16
Copy link
Collaborator Author

Hey! If you don't wish to make the Appwrite project API key accessible by users, your approach is good enough since there is no auth involved. Let the user clone and install cli2cloud and visit Appwrite to create their own API key and add it to the env variable. This way you'd not need to push your own access key.

💡 Another suggestion.

  • Add an example.env file to the repo and use .env file instead of cred.py, That's the best practice and a good code.
  • It'll become easy for the users to follow through with the installation with an example env file.

I'll be happy to contribute to a few repository restructure changes for you!

@thekaranatic
Copy link
Owner

thekaranatic commented Jul 5, 2023

I did try adding .env file and also pushed it here but deleted later because I was bit unaware of how this approach would work on others' systems. Anyways, thanks for suggesting that practice again and you are welcome to contribute to this project. As a beginner, it makes me happy as this marks the first external contribution to this repository from you!

@akashchouhan16
Copy link
Collaborator Author

Lovely! I'd need write access, please. Happy to help!
Steps:

   Settings > Access / Collaborators > Add People > @akashchouhan16

@thekaranatic
Copy link
Owner

Granted!

@thekaranatic
Copy link
Owner

Hi @akashchouhan16, hope you're doing well. Since there is no activity from you, I would like to know if you are interested in contributing to this issue. Would like a response from you by EOD.

@akashchouhan16
Copy link
Collaborator Author

Hey, bud! Had been caught up with work. Planning to restructure your project a bit, will tag you for review for the changes you wish to incorporate to cli2cloud. Meanwhile, you could explore what you'd want to add for the next version

@thekaranatic
Copy link
Owner

Sure!

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