/initialize_project_with_python

Python script to initialize a project with a repository on GitHub

Primary LanguagePythonCreative Commons Attribution Share Alike 4.0 InternationalCC-BY-SA-4.0

Initialize a project with Python

Small python script to automate the creation of a project in GitHub and your harddrive.

Project Automator

Installation

git clone git@github.com:tvdsluijs/initialize_project_with_python.git
cd initialize_project_with_python
python -m venv .venv # if you want to put it within an environment
source .venv/bin/activate # if you want to activate the environment
pip install -r requirements.txt
source ~/.my_commands.sh

Create a Github token

Then go to the folder config and set the 3 variables in a config.yml file

  • github_token = Your Github token
  • projects_folder_name = where your projects folder is c:/projectsfolder or /users/username/projectsfolder
  • license_template = Pick a for you appropriate license

Done!

If you want to use this script anywhere on your Mac place the create_project.sh in a global folder Something like ~/myscripts

Then In your .zshrc or bash profile you have to add a Export line Do

nano ~/.zshrc

or when using Bash

nano ~/.bash_profile

add this line at the end of the file with the correct path to this script

export PATH=~/MyBashScripts/all_scripts:$PATH

Why did I build this

Well you can read all about it in my blogpost.

Build status

Build status is ready!

Build Status

Tech/framework used

Python

Built with

PyCharm

This project Uses

  • PyGithub
  • pathlib

It's all in the requirements.txt so when you clone this repository and fire the following command all be good!

pip install -r requirements.txt

Help

You will find more about this project in:

#Initialize Projects

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

@Theo van der Sluijs