https://github.com/nstrydom2/neckbeard
An easy to use GIF meme generator
https://github.com/nstrydom2/neckbeard
gif meme-api meme-generator memes
Last synced: 2 months ago
JSON representation
An easy to use GIF meme generator
- Host: GitHub
- URL: https://github.com/nstrydom2/neckbeard
- Owner: nstrydom2
- License: mit
- Created: 2019-02-14T19:25:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-19T08:16:12.000Z (about 5 years ago)
- Last Synced: 2024-05-02T04:06:49.585Z (about 2 years ago)
- Topics: gif, meme-api, meme-generator, memes
- Language: Python
- Homepage:
- Size: 27.8 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# neckbeard Python library
Neckbeard is a lightweight and easy to use GIF meme generator built for Python3 application implementation.
## Getting Started
These instructions will get you a copy of the project up and running on your local
machine for development and testing purposes. See deployment for notes on how to
deploy the project on a live system.
### Prerequisites
Python 3.7+ is required to run this application and the Imagemagick application, other
than that there are no other prerequisites for the project, as the dependencies are
included in the repository.
### Installing
To install the library is as simple as cloning the repository and running
```bash
pip install -e .
```
It is recommended to create an virtual environment prior to installing this library.
Alternatively, you can also install this library via Pip:
```bash
pip install anonfile
```
### Dev Notes
Run unit tests locally:
```bash
pytest --verbosity=2 -s [--token "REDACTED"]
```
Add the `-k test_*` option if you want to test only a single function.
## Usage
Import the module and instantiate the `Neckbeard()` constructor with the image path as
a parameter. Set your meme text, positioning, and color. Then call the process method
to generate your new meme!
```python
from neckbeard import Neckbeard
# create meme from existing GIF
nb = Neckbeard('/home/ghost/Pictures/olaf.gif')
nb.top("tfw you have something important to do")
nb.bottom("but you don't care")
# process the new meme
nb.tip_fedora()
# create GIF meme from mp4
nb = Neckbeard(path='/home/ghost/Videos/wACDCVwsgGSS.mp4', start_time=(8, 52.0), end_time=(9, 15.0))
nb.top("tfw you have something important to do")
nb.bottom("but you don't care")
# process the new meme
nb.tip_fedora()
```
## Command Line Interface
```bash
# get help
neckbeard --help
# simple generate a meme
neckbeard --top "tfw you have something important to do" --bottom "but you just dgaf" --file /home/ghost/olaf_playing_nose.gif
```
## Built With
* [moviepy](https://zulko.github.io/moviepy/) - Python module for video editing
## Versioning
Navigate to [tags on this repository](https://github.com/nstrydom2/neckbeard/tags)
to see all available versions.
## Authors
| Name | Mail Address | GitHub Profile |
|------------------|-----------------------------|-----------------------------------------------|
| Nicholas Strydom | nstrydom@gmail.com | [nstrydom2](https://github.com/nstrydom2) |
See also the list of [contributors](https://github.com/nstrydom2/neckbeard/contributors)
who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for more details.
## Acknowledgments
* Joseph Marie Jacquard
* Charles Babbage
* Ada Lovelace
* My Dad
* Hat tip to anyone whose code was used
* Inspiration
* etc