Skip to main content

This is the magic bot by Castellani Davide

Project description

create_structure

GitHub license Author Version Language Python sys.platform supported On GitHub PyPI

Contents

Description

This is the magic :octocat: bot :octocat: by Castellani Davide With this programm you can easly create a repository on GitHub :octocat: with a basic template, personalized for your use.

Required

  • required python3 (>=3.8)
  • pip3
  • Internet connection
  • GitHub account

Setup

Attention: replace <SOME_WORDS> with your values

  • All OS using pypi:
    • pip install createstructure
    • Made an alias of use
      • Value of the alias: python3 -c "exec(\"from create_structure import create_structure\ncreate_structure()\")" -t=<TOCKEN> -s='<(optional)_ARRAY_OF_TEMPLATE_SOURCES>' -o=<(optional)_ORGANIZATION> -i='<(optional)_FOLDERS_TO_BE_IGNORED_FROM_TEMPLATE>
      • Eg. ubuntu/debian: alias createstucture='python3 -c "exec(\"from create_structure import create_structure\ncreate_structure()\")" -t=<TOCKEN> -s='<(optional)_ARRAY_OF_TEMPLATE_SOURCES>' -o=<(optional)_ORGANIZATION> -i='<(optional)_FOLDERS_TO_BE_IGNORED_FROM_TEMPLATE>'
  • Manual by source:
    • install git
    • download the repo git clone https://github.com/CastellaniDavide/create_structure.git
    • install python3
    • install pip3
    • install requirements.txt (in core of the project): pip3 install -r requirements/requirements.txt
    • create an alias
      • name: create_structure
      • attribute: python3 <ABSOLUTE_PATH_OF_REPO>/bin/create_structure.py -t= -s=<ARRAY_OF_SOURCES> -o=<(optional)_ORGANIZATION> -i=<(optional)_FOLDERS_TO_BE_IGNORED_FROM_TEMPLATE>

Update

  • With pypi method: pip3 install [package_name] --upgrade

Directories structure

  • .github
    • ISSUE_TEMPLATE
      • *.md
    • workflows
      • *.yml
  • create_structure
    • __init __.py
  • doc
    • _config.yml
    • LICENSE
    • README.md
  • requirements
    • requirements.txt
  • setup.py
  • .gitignore

Execution examples

  • create_structure

How to create your own template

1. Open father template

2. Clone the templete into your GitHub account

  • Press "Use this template" bottom
  • Compile the form that you see, take attention to the owner and make sure the visibity to "Public"

3. Modify it

  • You can clone on your PC and choose what and how to change (it's not a problem if you want to change all the structure :smile:)
  • Take attention to che .castellanidavide\change.json file
    • You can see some change examples => ... "from": "to", ...
    • Make attention to this special alias
      • sol<question_tag>sol -> the result of your answer in the form you made at the beginning
      • time__now -> Datetime (format yyyy-mm-dd)
      • time_now -> Datetime (format yyyymmdd)
      • (Do you have any idea? You can say me on the help email help@castellanidavide.it and I could add it to newer versions)
  • Rememper to push your changes

4. Add your account into research

  • Add your Own name into SOUCES_OF_TEMPLATES, keep attention to the order (i sugge

5. Try it

  • Try to execute this programm and check correct use

Changelog

6.0_2020-12-16

5.5_2020-12-13

  • Add first version of GitHub Actions

5.4_2020-12-12

  • Fixed some bugs
  • Changed the README.md
  • Create a setup method <= easier to use
  • Changed the way to give the tocken, ... => now by CLI

5.3_2020-11-29

  • removed some untils lines
  • accelerated the code
  • parametrized the folder to be ignored
  • start to use multitreading (41 sec. -> 10 sec.) (I made this test using this template)
  • optimized imports
  • optimised variables

5.2_2020-11-28

  • Added the website documentation
  • Fixed a bug

5.1_2020-11-28

  • Fixed a bug
  • Add team selection in runtime execution

5.0_2020-11-21

  • Fixed a bug
  • Made a better documentation
  • Optimized the question structure
  • Optimized the questions
  • Added some variables
    • Template sources list
    • Organization name (if you want to save into an Organization)
  • Removed some ununtil variables

4.0_2020-9-25

Changes
  • Fixed a bug
  • Remove the necessity of insert credentials any time
  • Download in any case, before only if public repo
  • removed unused files

3.1_2020-8-18

Changes
  • optimized the code
  • added requirements.txt

3.0_2020-8-15

Changes
  • add GitHub support with a lot of options (eg. repo private or public)

2.0_2020-3-24

Changes
  • adjusted some bugs
  • improved the program

1.0_2020-3-24

  • Initial version

Made by Castellani Davide If you have any problem please contact us:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

createstructure-6.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

createstructure-6.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file createstructure-6.0.tar.gz.

File metadata

  • Download URL: createstructure-6.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.0

File hashes

Hashes for createstructure-6.0.tar.gz
Algorithm Hash digest
SHA256 47b256db56b3279c8c6ba0688bbbf2f7217c44db7cace1fe8caa8876c22804fa
MD5 72fa6ca89bbe5ffab6f7ce3d36e9fc53
BLAKE2b-256 e3365cb65ecf3e167cdbef4fc9536ceac618b7d829e1c11ee153bab62b1f4807

See more details on using hashes here.

File details

Details for the file createstructure-6.0-py3-none-any.whl.

File metadata

  • Download URL: createstructure-6.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.0

File hashes

Hashes for createstructure-6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5dd16d20c3ffac1b1e67a8bc5fccdd7a1a09c761076bbc0e2fd78d41cc330376
MD5 39b5abcb915584fd01fb0c2a223e012d
BLAKE2b-256 e19ef526d50888c5c55b7213558dc9e0d8d3d937a3c47b572935562ae708fcc0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page