Auto Project Builder

The aim is to automate the repetitive task of creating directories and files for a new project. Refer to the Milestones section to better understand the features and scope of the project.

Functions:

create_simple_project()

Project created by the above function:

projectname/
│
├── project_name.py
├── test_project.py
├── setup.py
├── README.md
├── TODO.md
├── LICENSE
└── .gitignore

Usage for Mac/Linux Users

Prerequisites:

• You know the basics of using terminal on Mac/Linux.
  • How to use cd to change the current directory
  • Use ls to list directories in the current directory.
• You have the latest version of python installed.

1. Clone this repository into your projects folder, i.e. the folder you would like to create projects in.

Note: use cd command to navigate to your projects directory.

git clone www.github.com/radoid/auto-project-builder.git

2. Create a virtual environment in the auto-project-builder directory.

cd auto-project-builder
python3 -m venv pb_venv

3. Activate environment and install the required modules.

Note: check your python version by using python --version.

source pb_venv/bin/activate
pip install -r requirements.txt

4. Activate python in the terminal window.

python

5. Use the auto_pb module to create a simple project.

*Note: the following was written after completion of the first iteration of this project. More functions may be added since then.

from auto_pb import create_simple_project

# pb is an instance (object) of the ProjectBuilder class.
pb = create_simple_project()

# print the paths.
print(f'Path to the folder containing the project folder: {pb.path}')
print(f'Path to the project folder: {pb.proj_path}')

Possible improvements/personalisations you can make:

• modify the templates to suit your style.
• go through the ProjectBuilder class to add your own functionality.
• collaborate with me to improve the project. 😃

Contributing

There are Two ways to do this:

1. Collaborate
2. Code Review

Code Review

I will be mentioning your name in the Contribution section* for helpful and constructive feedback.

I would really appreciate any kind of feedback on the way I have chosen to tackle this problem. Keep in mind, I am a beginner and even a small piece of advice can go a long way. Be as critical as you can! Thank you for spending time to look at my code.

The best way to start is by going through the example codes in hangman/examples. I would appreciate comments on anything and everything, but here are some to get you started:

• Architecture or Design of the code.
• Style and Documentation.
• Testing: this one can be get time consuming compared to the others.

You can refer to this guide for advice on Code Reviews.

*I will be creating a Contributions through Code Reviews section.

Support

I am looking for a job ooportunity as a Software Developer and eventually Machine Learning Engineer in Canada. It would mean a lot if we could connect and discuss what we can do for each other. Follow and Reach out to me one of the following places!

License

MIT license