Gist2Joplin is a Python script that allows you to gather gists from GitHub and generate Joplin notes. It provides a seamless way to convert gists into Markdown notes, complete with tags and code blocks.
git clone https://github.com/DevGW/Gist2Joplin.git
cd Gist2Joplin
pip install -r requirements.txt
Follow these steps to obtain a GitHub API token:
- Visit the GitHub Personal Access Tokens page.
- Generate a new token with the appropriate permissions to access your Gists.
- Copy the generated token and securely store it.
Copy the config.json.example
file to config.json
:
cp config.json.example config.json
Edit the config.json
file and provide your GitHub username and API token.
To use Gist2Joplin, run the following command:
python gist2joplin.py <api_token>
To use Gist2Joplin, follow these steps:
- Install the necessary dependencies.
- Provide your GitHub API token.
- Run the script, passing the API token as an argument.
- Enjoy the generated Joplin notes!
This project is licensed under the MIT License.
The song "Gist2Joplin" was created as a fun and creative way to celebrate the development of the Gist2Joplin Python script. As a team, we wanted to express our enthusiasm and passion for this project through music.
The song was written by our friendly AI assistant as a collaborative effort with the team. It served as a creative outlet to highlight the script's features, functionality, and the collaborative effort that went into its creation.
Music has a unique way of connecting people, and we wanted to share our excitement with the community by presenting the script in a memorable and enjoyable way. We hope that this song adds a touch of joy and inspiration to your experience with Gist2Joplin.
Please sing along and enjoy the rhythm of Gist2Joplin!
Verse 1
In the realm of GitHub, where gists reside,
We embarked on a journey, side by side.
With Gist2Joplin, a script so profound,
Let's explore its wonders, let's break it down.
Chorus
Oh, Gist2Joplin, a tool we created,
To gather gists and have them generated.
With Markdown and tags, it weaves a story,
Converting gists into notes, in all their glory.
Verse 2
At its core, the script starts with initialization,
Setting up the API connection and authentication.
With headers and tokens, authorization secure,
The stage is set for a gist-gathering tour.
Chorus
Oh, Gist2Joplin, a tool we created,
To gather gists and have them generated.
With Markdown and tags, it weaves a story,
Converting gists into notes, in all their glory.
Bridge
We begin by fetching the user's gists,
Page by page, as the API assists.
As each gist is collected, the journey unfolds,
Building a list of tags, stories yet untold.
Verse 3
With the gists in hand, we enter the directories,
Creating a structure for files, no worries.
Tags are extracted, lowercase and sorted,
Duplicates removed, their uniqueness sorted.
Chorus
Oh, Gist2Joplin, a tool we created,
To gather gists and have them generated.
With Markdown and tags, it weaves a story,
Converting gists into notes, in all their glory.
Verse 4
The essence of each gist is captured with care,
Markdown content assembled, beyond compare.
For each file within, a decision is made,
Whether to include it directly or encase.
Chorus
Oh, Gist2Joplin, a tool we created,
To gather gists and have them generated.
With Markdown and tags, it weaves a story,
Converting gists into notes, in all their glory.
Outro
With files composed, the gists come alive,
Saved in the output, a success to strive.
Gist files generated, a testament to our quest,
A script that empowers, among the very best.
Chorus
Oh, Gist2Joplin, a tool we created,
To gather gists and have them generated.
With Markdown and tags, it weaves a story,
Converting gists into notes, in all their glory.
Outro continued
Let us celebrate the script we crafted as one,
A tool for organization, second to none.
Gist2Joplin, a melody of code and art,
A symphony of collaboration, forever in our heart.
Contributions to Gist2Joplin are welcome! If you find any issues or have suggestions for improvement, please submit an issue or a pull request. Follow these guidelines when contributing:
- Fork the repository and create a new branch for your contribution.
- Ensure your code follows the established coding conventions.
- Write tests for any new functionality or modifications.
Gist2Joplin is distributed under the MIT License.