Code Monkey home page Code Monkey logo

poetry-project-structure's Introduction

Poetry Project Structure

  1. Create a new repository on Github & initialise with a README. Optional:

    • Use the Python .gitignore github provides
      • If you are using Mac, add .DS_Store to your .gitignore before you commit any code
    • License - MIT is very popular and highly permissive if you want to share your code for re-use
  2. Clone the repository Example:

    gh repo clone kelvinducray/poetry-project-structure
    cd poetry-project-structure
    code .
    
  3. Initialise with Poetry

    poetry init
    poetry shell
    
  4. Create a project slug and starting scripts Your project slug will be your project name with underscores instead of dashes, then create an __init__.py and a __main__.py. The __main__.py is what will execute when you run:

    python -m <your_project_name>
    

    From the base directory of the project.

    Note: When import scripts within your project ensure you add a full-stop before the script name, e.g.:

    from .script import ...
    

poetry-project-structure's People

Contributors

kelvinducray avatar

Watchers

James Cloos avatar  avatar

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.