Pygifsicle
=========================================================================================
|pip| |downloads|
Python package wrapping the `gifsicle library <https://www.lcdf.org/gifsicle/>`_ for editing and optimizing gifs.
How do I install this package?
----------------------------------------------
As usual, just download it using pip:
.. code:: shell
pip install pygifsicle
While running the installation, on **MacOS** the setup will automatically install **gifsicle** using `Brew <https://brew.sh/>`_.
On Linux you will need to install **gifsicle** using apt-get as follows:
.. code:: shell
sudo apt-get install gifsicle
On Windows you will need to download and install the `correct port of the library <https://eternallybored.org/misc/gifsicle/>`_ for your OS.
Usage examples
----------------------------------------------
The library is currently pretty plain: it offers a wrapper to gifsicle and a method to optimize gifs, wrapping the options for gifsicle.
Optimizing a gif
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To optimize a gif, use the following:
.. code:: python
from pygifsicle import optimize
optimize("path_to_my_gif.gif")
General wrapper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To run gifsicle from Python use the following:
.. code:: python
from pygifsicle import gifsicle
gifsicle(
sources=["list.gif", "of.gif", "gifs.gif"], # or a single_file.gif
destination="destination.gif" # or just omit it and will use the first source provided.
optimize=False, # Whetever to add the optimize flag of not
colors=256, # Number of colors t use
options=["--verbose"] # Options to use.
)
Learn more about the general wrapper `by reading the function documentation. <https://github.com/LucaCappelletti94/pygifsicle/blob/0c7a1928eb0a5eb3dc99c46c227f970c7bd6b31b/pygifsicle/pygifsicle.py#L8>`_
Troubleshooting
---------------------------------------------------
One of the most common issues you can get, especially on windows, is that simply the **gifsicle** library is not available system wide. Do try to run `gifsicle` in your terminal to check if the library is properly installed.
Help and support
---------------------------------------------------
Wanna add another wrapper for easier usage? `Do a pull request! <https://github.com/LucaCappelletti94/pygifsicle/pulls>`_
Did you find an error or weird behavior? `Open an issue! <https://github.com/LucaCappelletti94/pygifsicle/issues>`_
.. |pip| image:: https://badge.fury.io/py/pygifsicle.svg
:target: https://badge.fury.io/py/pygifsicle
:alt: Pypi project
.. |downloads| image:: https://pepy.tech/badge/pygifsicle
:target: https://pepy.tech/badge/pygifsicle
:alt: Pypi total project downloads
Raw data
{
"_id": null,
"home_page": "https://github.com/LucaCappelletti94/pygifsicle",
"name": "pygifsicle",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Luca Cappelletti",
"author_email": "cappelletti.luca94@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b2/78/e6631e5f19fda153767e94dc3081fe4c9808f060105a3a74c07d47a64f13/pygifsicle-1.0.7.tar.gz",
"platform": null,
"description": "Pygifsicle\n=========================================================================================\n|pip| |downloads|\n\nPython package wrapping the `gifsicle library <https://www.lcdf.org/gifsicle/>`_ for editing and optimizing gifs.\n\nHow do I install this package?\n----------------------------------------------\nAs usual, just download it using pip:\n\n.. code:: shell\n\n pip install pygifsicle\n\nWhile running the installation, on **MacOS** the setup will automatically install **gifsicle** using `Brew <https://brew.sh/>`_.\n\nOn Linux you will need to install **gifsicle** using apt-get as follows:\n\n.. code:: shell\n\n sudo apt-get install gifsicle\n \nOn Windows you will need to download and install the `correct port of the library <https://eternallybored.org/misc/gifsicle/>`_ for your OS.\n\nUsage examples\n----------------------------------------------\nThe library is currently pretty plain: it offers a wrapper to gifsicle and a method to optimize gifs, wrapping the options for gifsicle.\n\nOptimizing a gif\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nTo optimize a gif, use the following:\n\n.. code:: python\n\n from pygifsicle import optimize\n optimize(\"path_to_my_gif.gif\")\n\n\nGeneral wrapper\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nTo run gifsicle from Python use the following:\n\n.. code:: python\n\n from pygifsicle import gifsicle\n gifsicle(\n sources=[\"list.gif\", \"of.gif\", \"gifs.gif\"], # or a single_file.gif\n destination=\"destination.gif\" # or just omit it and will use the first source provided.\n optimize=False, # Whetever to add the optimize flag of not\n colors=256, # Number of colors t use\n options=[\"--verbose\"] # Options to use.\n )\n\nLearn more about the general wrapper `by reading the function documentation. <https://github.com/LucaCappelletti94/pygifsicle/blob/0c7a1928eb0a5eb3dc99c46c227f970c7bd6b31b/pygifsicle/pygifsicle.py#L8>`_\n\nTroubleshooting\n---------------------------------------------------\nOne of the most common issues you can get, especially on windows, is that simply the **gifsicle** library is not available system wide. Do try to run `gifsicle` in your terminal to check if the library is properly installed.\n\nHelp and support\n---------------------------------------------------\nWanna add another wrapper for easier usage? `Do a pull request! <https://github.com/LucaCappelletti94/pygifsicle/pulls>`_\n\nDid you find an error or weird behavior? `Open an issue! <https://github.com/LucaCappelletti94/pygifsicle/issues>`_\n\n\n.. |pip| image:: https://badge.fury.io/py/pygifsicle.svg\n :target: https://badge.fury.io/py/pygifsicle\n :alt: Pypi project\n\n.. |downloads| image:: https://pepy.tech/badge/pygifsicle\n :target: https://pepy.tech/badge/pygifsicle\n :alt: Pypi total project downloads",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package wrapping the gifsicle library for editing and optimizing gifs.",
"version": "1.0.7",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "fef1670f14f63a6105d17fbd5c70804d",
"sha256": "506ae0e4c76992a4fd6097da2d3f224a869ad504879fb1191d6af96c3d394ef8"
},
"downloads": -1,
"filename": "pygifsicle-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "fef1670f14f63a6105d17fbd5c70804d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4595,
"upload_time": "2022-11-09T11:12:03",
"upload_time_iso_8601": "2022-11-09T11:12:03.329140Z",
"url": "https://files.pythonhosted.org/packages/b2/78/e6631e5f19fda153767e94dc3081fe4c9808f060105a3a74c07d47a64f13/pygifsicle-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-09 11:12:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "LucaCappelletti94",
"github_project": "pygifsicle",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pygifsicle"
}
JSON
