Metadata-Version: 2.1
Name: splashgen
Version: 0.0.22
Summary: Create a splash page in less than 20 lines of python
Home-page: https://github.com/true3dco/splashgen
Author: True3D
Author-email: founders@true3d.live
License: MIT
Description: # SplashGen
        
        ## Installation Instructions
        
        > **NOTE**: You will need Python 3.7+
        
        `pip install splashgen`
        
        ## Getting Started
        
        1. Copy the file contents of [this example](https://github.com/true3dco/splashgen/blob/master/examples/zenweb.py) into a py file of your own
        2. Change the values to reflect your brand
        3. Add in a logo.svg into the same directory as your py file
        4. Run `splashgen <<Your File>>.py` to build the static files
        5. Run `python -m http.server --directory build` to start a HTTP server in the output directory
        6. Head over to [http://localhost:8000/](http://localhost:8000/) to see your splashpage!
        
        ## Usage
        
        ### Deploying to GitHub pages
        
        _TODO_
        
        ### Deploying to Netlify
        
        _TODO_
        
        ### Opting out of analytics
        
        By default, splasgen sites contain a simple analytics snippet that helps us determine usage. **We explicitly opt-out of tracking
        any personally identifiable information, and only track the site's host name.** As a free and open-source product, it's important
        that we're able to measure usage of splashgen in order to continue to invest in its development.
        
        That said, you can easily opt-out of analytics tracking by adding the following code-snippet:
        
        ```python
        site.enable_splashgen_analytics = False
        ```
        
        ## Help us out! :pray:
        
        Splashgen is currently in an early alpha. If there are any missing features that you would like added please open an issue and we will add it in! This API is in flux and will receive significant improvements and changes over the next few weeks.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
