Git Product home page Git Product logo

ppc's Introduction

Python Project Creator


logo

flutter firebase

Just as Code Style, API Design, and Automation are essential for a healthy development cycle. Repository structure is a crucial part of your project’s architecture.

When a potential user or contributor lands on your repository’s page, they see a few things:

Project Name
Project Description
Bunch O’ Files

Only when they scroll below the fold will the user see your project’s README.

If your repo is a massive dump of files or a nested mess of directories, they might look elsewhere before even reading your beautiful documentation. Dress for the job you want, not the job you have.

Of course, first impressions aren’t everything. You and your colleagues will spend countless hours working with this repository, eventually becoming intimately familiar with every nook and cranny. The layout is important.

So, to solve that problem, here it is a vs-code extension which creates the best possible project structure.

How to install⚓️

Directly search for PPC or refer to this.

Preview📺

Demo

Known Issues🕵

  • "Open in new window" dialog appears way before completion of terminal's task.

  • Tested for linux os only.

How to Contribute🚀

  1. Fork the repo
  2. If the Issue you want to solve is not present in open issue, create an Issue.
  3. Comment on the issue, you want to work on.
  4. Work on your Fork and test it.
  5. Send A PR
  6. Follow me🙃

How to setup⭐️

  1. Clone the forked repo
  2. Go to the directory
  3. Run npm i or npm install
  4. To run the extension : Ctlr + f5
  5. To build the extension : npx vsce package

Different Project Structures🚧

  • Basic App Structure
projectName/
│
├── .gitignore
├── projectName.py
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── tests.py
└── env
  • Installable Package
projectName/
│
├── app
│   ├── __init__.py
|   ├── projectName.py
│   └── helpers.py
├── tests
│   ├── folder_name_tests.py
│   └── helpers_tests.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py
└── env
  • Flask-App: Basic
projectName
│
├── app
│   ├── __init__.py
    ├── projectName.py
│   ├── views.py
│   ├── models.py
│   ├── helpers.py
│   └── static
│       └── main.css
│   └── templates
│       └── index.html
├── config.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
  • Flask-App: Advanced
projectName
 ├── app
 │   ├── __init__.py
 |   ├── projectName.py
 │   ├── extensions.py
 │   │
 │   ├── helpers
 │   │   ├── __init__.py
 │   │   ├── views.py
 │   │   ├── models.py
 │   │   └── commands.py
 │   │
 │   ├── auth
 │   │   ├── __init__.py
 │   │   ├── routes.py
 │   │   ├── views.py
 │   │   ├── models.py
 │   │   ├── forms.py
 │   │   └── commands.py
 │   │
 │   └── ui
 │       ├── static
 │       │   ├── css
 │       │   │   └── styles.css
 │       │   └── js
 │       │       └── custom.js
 │       │
 │       └── templates
 │           ├── 404.html
 │           ├── 500.html
 │           └── base.html
 │
 ├── tests
 │   ├── __init__.py
 │   ├── conftest.py
 │   │
 │   └── auth
 │       ├── __init__.py
 │       └── test_views.py
 │
 ├── config.py
 ├── wsgi.py
 ├── requirements.txt
 └── README.md

References😸

If you like it, ⭐️ this repo 🙃

ppc's People

Contributors

akhileshmattam avatar iamabhishekkumar avatar

Stargazers

 avatar

Watchers

 avatar

ppc's Issues

If no folder is opened and if try to create a project then it will throw an error.

To Reproduce
Run the "create python project" command without opening a folder.

Expected behavior
A dialog box should be popped up, showing that we have to open a folder before runnng the command, something like that.

Desktop (please complete the following information):

  • OS: Ubuntu
  • VS Code Version : 1.66.0

Preview

2022-04-04.18-05-22.online-video-cutter.com.mp4

"Call open in new window" only when the terminal process ends.

I haven't found any way to check when my terminal process ends. So, i hard coded a delay of 4 s after my terminal process starts.

function genEnvironment(folderPath, additionalCommand = "") {
    const originalFolderPath = folderPath;
    folderPath = `'${folderPath}'`;  // to fix that if their is space in between the path.
    const terminal = vscode.window.createTerminal(`bash`);
    terminal.show(true);
    terminal.sendText(`cd ${folderPath}`);
    terminal.sendText(`python3 -m venv env || python -m venv env`);
    terminal.sendText(`source ${folderPath}/env/bin/activate`);
    if (additionalCommand != "")
        terminal.sendText(additionalCommand); // can be used for pip install flask
    terminal.sendText(`pip freeze > ${folderPath}/requirements.txt`);
    terminal.sendText(`deactivate`);
    terminal.sendText(`exit`);
    sleep(4000).then(() => commands.openInNewWindow(originalFolderPath));
}

PATH TO THIS FUNCTION = scripts/generate.js

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.