napoii / new_py_code

🚀🐍 New_py_Code: Python project automates folder creation, file management for developers. Setup, run locally with Python 3.10.7. Innovative, efficient workflow enhancement. GitHub repo includes README, TODO, license. Connect on Discord. Happy coding! #Python #GitHub 🚀🐍

An innovative Python project that automates folder creation and file management, streamlining workflow and increasing efficiency for developers.

Running Locally

This application requires Python 3.10.7.

git clone https://github.com/NapoII/New_py_Code
pip install -r requirements.txt
run Code New_py_Code.py

Example

Files folders created by New_py_Code:

Test123/
┣ README_img/
┃ ┗ Readme_top.png
┣ test/
┃ ┗ test.py
┣ Test123/
┃ ┣ config/
┃ ┃ ┗ config.ini
┃ ┣ util/
┃ ┃ ┣ __funktion__.py
┃ ┃ ┗ __init__.py
┃ ┗ Test123.py
┣ .gitignore
┣ README.md
┣ requirements.txt
┣ setup.py
┗ TODO.md

TODO

---

Basic

• New project generated with [New_py_Code]

• Initialise a new Git with Git Bash:

  git init
  git add.
  git commit -"Hello world"
  

• Create a new repository on gitHub: https://github.com/new

• Add the desired licence, for example: MIT License

• Create remote access to the repository with Git Bash and push the project to GitHub.

  git remote o https://github.com/<GitHub User name>/<repository name>
  git push o main
  

• ☕ Now that the base is in place Treat yourself to a cup of tea.

---

Start

• Start your coding
• end big step with a git commit. Add files/folders previously locked to Git to the .gitignore as needed.

  git add .
  git commit "<text>"
  git push o main
  

• ☕ Now that the first code is up, take some time for Tea again and write down your next steps here in the TODO file.
• --

The Finish

• Run the code for the final test

• If the code does what it is supposed to do, do another push into git and go into finishing.

  git add .
  git commit "Finel Test is over!"
  git push o main
  

• Delete all folders and files you no longer need.

• Check your code and files for missing dokus. *ChatGPT kann dir die arbeit abnehmen use:

      write me a .py docstr ("""""") with the content: 
      Args, Returns, Example Usage for the code in eng.
      Use for Args and Returns "- " for a listing and for Example Usage: ">>> ".
      Here is the code: <your code Snippet>
      ```
  

• If you have used another language translate the code into english.

• Complete the requirements.txt list.

• Delete all private data from the config file.

• ☕ Have a Tea and think about the content of the ReadMe.

• Write the readme.

• check the setup.py if it still exists.

• check the .gitignor file.

• Final git Push:

      git add .
      git commit "Touchdown! "
      git push o main
      ```
  

• Upload to pypi if desired : nice guide for pypi publishing https://betterscientificsoftware.github.io/python-for-hpc/tutorials/python-pypi-packaging/

• ☕ Your are DONE! ONE LAST TEA.

Bugs

• --

---

Ideas

• --

Lizenz

GNU GENERAL PUBLIC LICENSE Version 3

MIT License

Copyright (c) 2023 NapoII Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE