Skip to content

savdbroek/shopicord

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues License


Logo

Shopicord

A Discord bot to retrieve Shopify Orders and Statistics
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a simple Discord bot I developed to keep track of orders on my own Shopify Store. It was my first Python project and never intended for the public. However, I feel like it might be of use to someone out there. I will be going through the code eventually to optimize it.

Please let me know if you find any bugs or have feature requests!

Built With

  • Python

Getting Started

Prerequisites

The following things are required before using this project.

Installation

  1. Clone the repo
    git clone https://github.com/savdbroek/shopicord.git
  2. Edit the .env file in /app
    nano app/.env
  3. Add your Discord ID to authors list in bot.py
    authors = [YOUR DISCORD ID('s)]
  4. Build & Run the Container
    docker run -it $(docker build -q .)

(back to top)

Setup Discord Bot

Use the following page to create your own Discord Bot:

[https://discordpy.readthedocs.io/en/stable/discord.html](Creating a Discord bot)

You need your Bot Token.

Setup Shopify App

Don't worry you won't need to do anything complicated. Just open up your Shopify Admin page and follow along.

  1. Open Settings
  2. Open Apps and sales channels
  3. Click Develop Apps
  4. Click Create an App
  5. Give your App a beautiful name (Does not matter what)
  6. Click Create App
  7. Click Configure Admin API Scope
  8. Check the following boxes:
    • read_analytics
    • read_assigned_fulfillment_orders
    • read_customers
    • read_inventory
    • read_orders
    • read_product_listings
    • read_products
    • write_reports
    • read_reports
    • read_shopify_payments_payouts
  9. Click Save
  10. Click API Credentials
  11. Click Install App
  12. Click Reveal token once
  13. Copy your Shopify API Token
  14. Paste your Shopify API Token into app/.env

Usage

Currently there two commands:

  • !orders - Display a list of all current open orders + show closed orders from current month and current balance
  • !order order_# - Takes order number as argument. Shows information abou the order.

(back to top)

Roadmap

  • Optimize and cleanup code
  • You name it ;)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.

(back to top)

Contact

Sander van den Broek - savdbroek@proton.me

Project Link: https://github.com/savdbroek/shopicord

(back to top)

Acknowledgments

(back to top)