FigureForge


NameFigureForge JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-09-20 16:35:51
maintainerNone
docs_urlNone
authorNoah Gula
requires_python<3.12,>=3.9
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center"> <img width="30%" src="./FigureForge/resources/assets/logo_color_text.png"> </p>

A Python GUI application for interactive creation and editing of matplotlib figures.

## Features
- Edit matplotlib figures via a graphical interface.
  - Adjust text labels, size, fonts, etc.
  - Change colors of lines, text, symbols, etc.
  - Adjust size of markers, lines
  - And more!
- [Save figures](htthttps://github.com/nogula/FigureForge/wiki/FAQ-&-Troubleshooting#how-does-figureforge-save-figure-data) to a pickle file for use in other Python projects or to share (and load figures from a pickle file, too!).
- Use [custom plugins](https://github.com/nogula/FigureForge/wiki/Plugins) to automate figure styling.

![](https://raw.githubusercontent.com/nogula/FigureForge/main/FigureForge/resources/assets/demo.png)

## Installation

1. Open a terminal or command prompt.
2. Optionally, create a virtual environment.
3. Run the following command to install FigureForge:

    ```
    pip install FigureForge
    ```
    _You may need to uninstall FigureForge before upgrading._
4. Start FigureForge from the terminal:
    ```
    FigureForge
    ```
    or from within a script:
   ```
   import matplotlib.pyplot as plt
   import FigureForge

   fig, ax = plt.subplots()
   ax.plot([1,2,3,4],[1,4,9,16])

   # Do edits with FigureForge...
   fig = FigureForge.run(fig)
   # Continue your script after FigureForge closes...
   ```

## Help
The documentation for FigureForge is available on the project's [wiki](https://github.com/nogula/FigureForge/wiki) -- it is still a work in progress, but in the meantime you might find the [FAQ & Troubleshooting](https://github.com/nogula/FigureForge/wiki/FAQ-&-Troubleshooting) page helpful. Consider also creating a [new issue](https://github.com/nogula/FigureForge/issues), or ask a question in the [discussions](https://github.com/nogula/FigureForge/discussions/1).

## Contributing
Obviously, FigureForge is still early in development. Correspondingly, there are many opportunities to implement features and fix bugs. If you want to pitch in, you are welcome to fork the project and make a pull request.

Truth be told, I am an aerospace engineer and not a software developer; I don't know how to develop professional software, but am doing my best - especially because FigureForge is solving one of my own problems. If you would like to contribute, I would be grateful. There is no formal development philosophy: I just recently learned that git tags are a thing. The closest thing to a development roadmap is this Kanban board, granted, these features are to some extent aspirational: [FigureForge Project](https://github.com/users/nogula/projects/3/views/1).

## Acknowledgements
FigureForge is possible only because of the open source technologies and resources from which FigureForge stands on shoulders. Specifically, I wish to thank:
- The developers of [matplotlib](https://matplotlib.org/) who are responsible for the very foundation of this project.
- The GUI framework for FigureForge is the Qt platform, specifically [PySide6](https://pypi.org/project/PySide6/).
- The menu [icons](https://fonts.google.com/icons) used in FigureForge were made by Google.

## See Also
A unique function of FigureForge is its ability to work on matplotlib figures as part of any Python workflow. However, if you are looking for something more polished and are not so concerned with the serialization/data format of your figure, you might find the following projects of interest.
- [Veusz](https://veusz.github.io/) is a scientific plotting and graphing program with a graphical user interface, designed to produce publication-ready 2D and 3D plots.
- [LabPlot](https://labplot.kde.org/) open source and cross-platform Data Visualization and Analysis software accessible to everyone.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "FigureForge",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Noah Gula",
    "author_email": "noahrgula@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/35/12/afbb013034293748e196f725fee33f4bd3deec4206e9f7a287062457945b/figureforge-0.3.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\"> <img width=\"30%\" src=\"./FigureForge/resources/assets/logo_color_text.png\"> </p>\n\nA Python GUI application for interactive creation and editing of matplotlib figures.\n\n## Features\n- Edit matplotlib figures via a graphical interface.\n  - Adjust text labels, size, fonts, etc.\n  - Change colors of lines, text, symbols, etc.\n  - Adjust size of markers, lines\n  - And more!\n- [Save figures](htthttps://github.com/nogula/FigureForge/wiki/FAQ-&-Troubleshooting#how-does-figureforge-save-figure-data) to a pickle file for use in other Python projects or to share (and load figures from a pickle file, too!).\n- Use [custom plugins](https://github.com/nogula/FigureForge/wiki/Plugins) to automate figure styling.\n\n![](https://raw.githubusercontent.com/nogula/FigureForge/main/FigureForge/resources/assets/demo.png)\n\n## Installation\n\n1. Open a terminal or command prompt.\n2. Optionally, create a virtual environment.\n3. Run the following command to install FigureForge:\n\n    ```\n    pip install FigureForge\n    ```\n    _You may need to uninstall FigureForge before upgrading._\n4. Start FigureForge from the terminal:\n    ```\n    FigureForge\n    ```\n    or from within a script:\n   ```\n   import matplotlib.pyplot as plt\n   import FigureForge\n\n   fig, ax = plt.subplots()\n   ax.plot([1,2,3,4],[1,4,9,16])\n\n   # Do edits with FigureForge...\n   fig = FigureForge.run(fig)\n   # Continue your script after FigureForge closes...\n   ```\n\n## Help\nThe documentation for FigureForge is available on the project's [wiki](https://github.com/nogula/FigureForge/wiki) -- it is still a work in progress, but in the meantime you might find the [FAQ & Troubleshooting](https://github.com/nogula/FigureForge/wiki/FAQ-&-Troubleshooting) page helpful. Consider also creating a [new issue](https://github.com/nogula/FigureForge/issues), or ask a question in the [discussions](https://github.com/nogula/FigureForge/discussions/1).\n\n## Contributing\nObviously, FigureForge is still early in development. Correspondingly, there are many opportunities to implement features and fix bugs. If you want to pitch in, you are welcome to fork the project and make a pull request.\n\nTruth be told, I am an aerospace engineer and not a software developer; I don't know how to develop professional software, but am doing my best - especially because FigureForge is solving one of my own problems. If you would like to contribute, I would be grateful. There is no formal development philosophy: I just recently learned that git tags are a thing. The closest thing to a development roadmap is this Kanban board, granted, these features are to some extent aspirational: [FigureForge Project](https://github.com/users/nogula/projects/3/views/1).\n\n## Acknowledgements\nFigureForge is possible only because of the open source technologies and resources from which FigureForge stands on shoulders. Specifically, I wish to thank:\n- The developers of [matplotlib](https://matplotlib.org/) who are responsible for the very foundation of this project.\n- The GUI framework for FigureForge is the Qt platform, specifically [PySide6](https://pypi.org/project/PySide6/).\n- The menu [icons](https://fonts.google.com/icons) used in FigureForge were made by Google.\n\n## See Also\nA unique function of FigureForge is its ability to work on matplotlib figures as part of any Python workflow. However, if you are looking for something more polished and are not so concerned with the serialization/data format of your figure, you might find the following projects of interest.\n- [Veusz](https://veusz.github.io/) is a scientific plotting and graphing program with a graphical user interface, designed to produce publication-ready 2D and 3D plots.\n- [LabPlot](https://labplot.kde.org/) open source and cross-platform Data Visualization and Analysis software accessible to everyone.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": null,
    "version": "0.3.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bcd24e722ac04421004ad91c4fe46baa15fda9ba9ee9056edcf19805e8425813",
                "md5": "16f6d1d15317f811290d12f48078138d",
                "sha256": "492550667629a0fc4f4e86b06d591d4c27e9483e335cc2f3edddcdad7175d543"
            },
            "downloads": -1,
            "filename": "figureforge-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "16f6d1d15317f811290d12f48078138d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.9",
            "size": 724944,
            "upload_time": "2024-09-20T16:35:49",
            "upload_time_iso_8601": "2024-09-20T16:35:49.053475Z",
            "url": "https://files.pythonhosted.org/packages/bc/d2/4e722ac04421004ad91c4fe46baa15fda9ba9ee9056edcf19805e8425813/figureforge-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3512afbb013034293748e196f725fee33f4bd3deec4206e9f7a287062457945b",
                "md5": "52e3bf666f1a70058dc0725401b7f4b1",
                "sha256": "7d3e276a4afeadbd98a9bc245a00c74d1cb2c96aaebff46b14819ccaf378c294"
            },
            "downloads": -1,
            "filename": "figureforge-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "52e3bf666f1a70058dc0725401b7f4b1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.9",
            "size": 714433,
            "upload_time": "2024-09-20T16:35:51",
            "upload_time_iso_8601": "2024-09-20T16:35:51.055118Z",
            "url": "https://files.pythonhosted.org/packages/35/12/afbb013034293748e196f725fee33f4bd3deec4206e9f7a287062457945b/figureforge-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-20 16:35:51",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "figureforge"
}
        
Elapsed time: 0.79226s