attix

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

:eyeglasses: TLDR

A very succinct paragraph summary regarding the package purpose and operation.

:film_projector: Demo

---

Put a demo animated gif here.

:bulb: Project rationale

---

Why I built this project

:rocket: Quickstart

---

Explain succinctly how to use the repository

:spiral_notepad: Prerequisites

• A bulleted list of requirements

:floppy_disk: Installation

OS X & Linux:

pip3 install attix

Windows:

pip install attix

:computer: Basic Usage

A simple example demonstrating that the package is working

:computer: 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.

:wrench: 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 attix

:gear: Configuration

---

Place configuration information here

:lock: Security Considerations

---

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

:books: Documentation

---

Read the Docs

• Example Usage
• Credits
• Changelog
• API Reference

Wiki

:dna: Design Considerations

---

A few paragraphs on the design considerations if required.

:whale: 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/attix:0.1.0 -t sraking/attix:latest .

Once built, run the image using the docker run command. This will create the container. e.g.

$ docker run -it sraking/attix: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/attix: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/attix

Now run the image using the docker run command. This will create the container. e.g.

~ $ docker run -it sraking/attix /bin/bash

Use the command line as normal in the container.

root@4d315992ca28:/app# attix -h

:warning: Limitations

---

Describe any limitation the application may have (if any).

:interrobang: Some Quirks

---

The reason I wrote this application in the first place.

:question: FAQs

---

Give examples of frequently asked questions

:newspaper: What's new in version x.x

---

• bulleted list of new features

:calendar: Planned future enhancements

---

• Feature 1
• Feature 2

:bar_chart: Package statistics

---

• libraries.io
• PyPI Stats
• Pepy

:scroll: License

---

Distributed under the MIT license. See for more information.

< :information_source: > Meta

---

Author: Stephen R A King (sking.github@gmail.com)

Created with Cookiecutter template:

Digital object identifier: