Medium Project

The demo project for Medium article

Description

An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

• Describe any prerequisites, libraries, OS version, etc., needed before installing program.
• ex. Windows 10

Installing

• How/where to download your program
• Any modifications needed to be made to files/folders

Executing program

• How to run the program
• Step-by-step bullets

code blocks for commands

Structure

medium_project
├── .devcontainer
│   ├── Dockerfile
│   ├── devcontainer.json
│   └── post-install.sh
├── artifacts
├── data
├── sandbox
├── src
│   └── medium_project
│       └── __init__.py
├── tests
│   └── __init__.py
├── .bashrc
├── LICENCE.txt
├── README.md
├── poetry.toml
├── pyproject.toml
├── pytest.ini
└── tox.ini

8 directories, 12 files

Configuration

You can inherit some configurations from the host to the container with the help of bind mounts. There are 2 built-in bind mounts, defined in ./.devcontainer/devcontainer.json:

• Git confuguration: from ~/.gitconfig on the host to /home/vscode/.gitconfig on the container,
• .env file: from ~/.ssh/.env on the host to /home/vscode/.ssh/.env on the container,

Help

Any advise for common problems or issues.

command to run if program contains helper info

Roadmap

• Initial release
• Fly to the Moon!

Authors

Contributors names and contact info:

• Jarek Grygolec: jgrygolec@gmail.com

Version History

• 0.1
  • Initial Release

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

• awesome-readme
• Using Python and Poetry inside a Dev Container
• How To Test And Build Python Packages With Pytest, Tox And Poetry