diff --git a/bruhanimate/__init__.py b/bruhanimate/__init__.py index 76be33e..3148f05 100644 --- a/bruhanimate/__init__.py +++ b/bruhanimate/__init__.py @@ -82,7 +82,7 @@ ) -__version__ = "0.2.85" +__version__ = "0.2.87" __valid_demos__ = [ "static_demo", "offset_demo", diff --git a/docs/source/bruheffect/index.rst b/docs/source/bruheffect/index.rst index f5b7b29..efc5662 100644 --- a/docs/source/bruheffect/index.rst +++ b/docs/source/bruheffect/index.rst @@ -1,11 +1,81 @@ + + Bruheffect ========== This section contains content related to the bruheffect package. +Overview +-------- +The ``bruheffect`` package is a versatile library designed to create a variety of visual and auditory effects. This package includes multiple modules, each offering unique functionalities to enhance your multimedia projects. Whether you are developing animations, interactive applications, or simply exploring creative coding, ``bruheffect`` provides a comprehensive suite of effects to bring your ideas to life. + +Key Modules and Purposes: + +- **audio_effect** + + Handles auditory transformations and sound manipulations, allowing the integration of soundscapes or audio effects into your projects. + +- **base_effect** + + Provides the foundational elements and utilities used across other effect modules, serving as the core of the package's infrastructure. + +- **chatbot_effect** + + Implements effects that can be triggered by chatbots, enabling integration with conversational interfaces. + +- **draw_lines_effect** + + Focuses on rendering line-based visuals, ideal for creating stylized line art or dynamic geometries. + +- **firework_effect** + + Simulates firework displays, offering colorful and explosive visualizations for celebratory animations. + +- **game_of_life_effect** + + Emulates Conway's Game of Life, offering a classic cellular automaton effect for use in simulations or educational projects. + +- **matrix_effect** + + Recreates the iconic "Matrix" digital rain effect, perfect for adding a cyberpunk aesthetic to any project. + +- **noise_effect** + + Generates random noise patterns, useful for texture generation or background visuals. + +- **offset_effect** + + Provides effects that involve shifting or displacing visual elements, allowing for creative distortions and transitions. + +- **plasma_effect** + + Displays vibrant, swirling plasma patterns, ideal for creating psychedelic visual effects. + +- **rain_effect** + + Simulates falling rain, enhancing atmospheric or weather-related animations. + +- **snow_effect** + + Adds falling snow effects, perfect for winter-themed projects or seasonal greetings. + +- **star_effect** + + Renders starry skies or cosmic scenes, suitable for space and astronomy animations. + +- **static_effect** + + Recreates television static or noise, useful for glitch effects or retro aesthetics. + +- **twinkle_effect** + + Provides twinkling star effects, adding sparkle and dynamism to celestial backgrounds. + +Explore these modules to discover the diverse effects you can achieve with the ``bruheffect`` package, and unleash your creativity in visual and auditory design. + + .. toctree:: :maxdepth: 2 - :caption: Bruheffect Contents: audio_effect base_effect @@ -21,8 +91,4 @@ This section contains content related to the bruheffect package. snow_effect star_effect static_effect - twinkle_effect - -Overview --------- -Description of the bruheffect modules and their purposes... + twinkle_effect \ No newline at end of file diff --git a/docs/source/bruhrenderer/index.rst b/docs/source/bruhrenderer/index.rst index 34af8eb..dcc5c48 100644 --- a/docs/source/bruhrenderer/index.rst +++ b/docs/source/bruhrenderer/index.rst @@ -3,17 +3,43 @@ Bruhrenderer This section contains content related to the bruhrenderer package. +Overview +-------- +The `bruhrenderer` package is a specialized library crafted for rendering high-quality graphics and animations. It includes a collection of modules, each dedicated to specific rendering tasks and effects to enhance visual presentations. Whether you're working on animation projects, graphical applications, or visual explorations, `bruhrenderer` offers the necessary tools to achieve stunning visual results. + +Key Modules and Purposes: + +- **background_color_renderer** + + Manages the rendering of background colors, enabling dynamic transformations and customizations to suit varying aesthetic needs. + +- **base_renderer** + + Provides essential rendering functionalities, creating a foundational layer that supports more specialized rendering tasks across the package. + +- **center_renderer** + + Facilitates the centering of graphical elements within the rendering context, ensuring precision in positioning and layout. + +- **effect_renderer** + + Applies a range of visual effects, enhancing graphics with sophisticated visual transformations like shadows and glows. + +- **focus_renderer** + + Implements focus effects to highlight or emphasize elements, simulating camera-like focus techniques in graphical presentations. + +- **pan_renderer** + + Manages the smooth panning of scenes, allowing for dynamic movement and transitions of visual elements across the render field. + + .. toctree:: :maxdepth: 2 - :caption: Bruhrenderer Contents: - + background_color_renderer base_renderer center_renderer effect_renderer focus_renderer pan_renderer - -Overview --------- -Description of the bruhrenderer modules and their purposes... diff --git a/docs/source/bruhutil/index.rst b/docs/source/bruhutil/index.rst index 3bf1d70..c9699d5 100644 --- a/docs/source/bruhutil/index.rst +++ b/docs/source/bruhutil/index.rst @@ -3,9 +3,39 @@ Bruhutil This section contains content related to the bruhutil package. +Overview +-------- +The `bruhutil` package is a comprehensive utility library designed to support a wide range of programming tasks. It consists of diverse modules, each offering specialized functionalities that enhance efficiency and ease of development in multimedia and general-purpose programming projects. Whether you need error handling, buffer management, or type utilities, `bruhutil` is equipped to meet your utility needs. + +Key Modules and Purposes: + +- **bruherrors** + + Provides robust error handling mechanisms and utilities, ensuring smoother debugging and reliability in application performance. + +- **bruhffer** + + Handles buffer operations, facilitating efficient data handling and manipulation for high-performance applications. + +- **bruhimage** + + Offers image processing utilities, supporting tasks like image manipulation, conversion, and analysis to enhance graphical projects. + +- **bruhscreen** + + Manages screen-related operations, enabling seamless interface interactions and screen management tasks. + +- **bruhtypes** + + Supplies type utilities, offering functions and classes that simplify type management and conversions in coding projects. + +- **utils** + + Contains additional utility functions and helpers, addressing common programming requirements and simplifying complex tasks. + + .. toctree:: :maxdepth: 2 - :caption: Bruhutil Contents: bruherrors bruhffer @@ -13,7 +43,3 @@ This section contains content related to the bruhutil package. bruhscreen bruhtypes utils - -Overview --------- -Description of the bruhutil modules and their purposes... diff --git a/setup.py b/setup.py deleted file mode 100644 index bb3fdf5..0000000 --- a/setup.py +++ /dev/null @@ -1,47 +0,0 @@ -from setuptools import setup, find_packages -import codecs -import os -import sys - -here = os.path.abspath(os.path.dirname(__file__)) - -with codecs.open(os.path.join(here, "README.md"), encoding="utf-8") as fh: - long_description = "\n" + fh.read() - -VERSION = "0.2.80" -DESCRIPTION = 'ASCII Terminal Animation Package' -LONG_DESCRIPTION = 'A package that allows for various animations in the terminal' - -# Setting up -setup( - name="bruhanimate", - version=VERSION, - author="Ethan Christensen", - author_email="ethanlchristensen@outlook.com", - description=DESCRIPTION, - long_description_content_type="text/markdown", - long_description=long_description, - url='https://github.com/ethanlchristensen/bruhanimate', - packages=find_packages(), - install_requires=[ - "future", - "bruhcolor", - "pyfiglet", - "numpy", - "openai", - "requests" - ], - extras_require={ - ':sys_platform == "win32"': ["pywin32", "pyaudio"], - }, - setup_requires=['setuptools_scm'], - keywords=['python', 'terminal', 'terminal-animation', 'bruhanimate'], - classifiers=[ - "Development Status :: 4 - Beta", - "Intended Audience :: Developers", - "Programming Language :: Python :: 3", - "Operating System :: Unix", - "Operating System :: MacOS :: MacOS X", - "Operating System :: Microsoft :: Windows", - ] -) \ No newline at end of file