Hermodr Ghost Application

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

I currently write reviews for movies, TV shows, and book for my own fun. However, I have been publishing them to a blog for the past year. However, this has become faily tedious and I want to be able to automate as much as I can. Currently I use Obsidian to write the reviews and then they are manually published on a Ghost blog that I selfhost on a VPS. After writing the review, I copy and paste it to the blog and then setup a publish date and email. This works without issue, but I hate the back and forth.

This project should accomplish the following with some thoughts below each step:

1. Scan repository of my backed up obsidian notes. (This might be better suited for something like gitlab or gitea, but for now will be a script to practice python skills and transferability for other users.)
2. If the repository has new notes that meet certain requirements (Either is labeled as completed or no additional edits in 72 hours), stag to publish to ghost.
3. Publish notes to Ghost blog using API.
4. Scehdule weekly email to go out with excerpt and score for the review (Right now, each review has its own email. This really isn't the best as I personally hate getting blaseted by emails from people and would prefer a weekly roll up to see if anything is worth reading. So this weekly email will have an excert from each review and then the score).

I will be building this with OOP in mind.

(back to top)

Built With

• Python

(back to top)

Getting Started

Download the git project.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

This project assumes a couple things.

1. You use obsidian to save your blogs.
2. You use Obsidian Git to save your vault to Github.
3. You are using Ghost to host your blogs.

git clone https://github.com/m1cypher/hermodr-ghost.git

Installation

1. Modify permissions for the scripts

cd /hermodr-ghost
chmod +x *.sh

(back to top)

Usage

After working prototype is completed, you can check out the wiki page for documentation.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Create repository scanning script
• Create DB to store the published blogs.
• Create Blog publicion script
• Create Email Publication script
• Create Good Reads review script (Version 1.1 or 2.0 or whatever)

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 MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @mimircyber - [email protected]

Project Link: https://github.com/m1cypher/hermodr-ghost

(back to top)

Acknowledgments

Thank you to my friend Fleet for helping by coach and project manager.

• Flyoungiv

(back to top)