agrajag 0.1.0

Description:

agrajag 0.1.0

agrajag

Short blurb about what your product does.
























One to two paragraph statement about your product and what it does.

Contents

Demo
Project rationale
Quick start

Prerequisites
Installation
Basic Usage


Usage
Development setup
Configuration
Documentation

Read the Docs
API
Wiki


FAQs
What's new in version x.x
Planned future enhancements
Package statistics
License
Meta information

📺 Demo

Put a demo animated gif here.
💡 Project rationale

Why I built this project
👓 TLDR
A very succinct paragraph summary regarding the package purpose and operation.
🚀 Quickstart

Explain succinctly how to use the repository
📋 Prerequisites

A bulleted list of requirements

💾 Installation
OS X & Linux:
pip3 install agrajag

Windows:
pip install agrajag

📝 Basic Usage
A simple example demonstrating that the package is working
📝 Usage

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
For more examples and usage, please refer to the Wiki.
🔧 Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
pip install --editable agrajag

⚙️ Configuration

Place configuration information here
🔒 Security Considerations

Write any security concerns that you may have here.
e.g. exposure of API keys, passwords, old modules etc.
📚 Documentation

Read the Docs

Example Usage
Credits
Changelog
API Reference

Wiki
🧬 Design Considerations

A few paragraphs on the design considerations if required.
🐳 Using Docker

Building the Image from Dockerfile
Start your docker runtime then:
Build the image using docker build command. e.g.
$ docker build -t sraking/agrajag:0.1.0 -t sraking/agrajag:latest .

Once built, run the image using the docker run command. This will create the container. e.g.
$ docker run -it sraking/agrajag:0.1.0 /bin/bash

Optional: The image can now be pushed to the repository using the docker push command. e.g.
$ docker push sraking/agrajag:0.1.0

Using the ready built image on dockerhub
Pull the latest image from the repository using the docker pull command. e.g.
~ $ docker pull sraking/agrajag

Now run the image using the docker run command. This will create the container. e.g.
~ $ docker run -it sraking/agrajag /bin/bash

Use the command line as normal in the container.
root@4d315992ca28:/app# agrajag -h

⚠️ Limitations

Describe any limitation the application may have (if any).
⁉️ Some Quirks

The reason I wrote this application in the first place.
❓ FAQs

Give examples of frequently asked questions
📰 What's new in version x.x


bulleted list of new features

📆 Planned future enhancements


Feature 1
Feature 2

📊 Package statistics


libraries.io
PyPI Stats
Pepy

📜 License

Distributed under the MIT license. See for more information.
<ℹ️> Meta








Author: Stephen R A King ([email protected])
Created with Cookiecutter template: version 1.3.4
Digital object identifier: