Metadata-Version: 2.1
Name: sitemap-builder
Version: 0.0.1
Summary: Generate sitemaps from programmatically collected URLs
Home-page: https://github.com/marcanuy/sitemap-builder
Author: Marcelo Canina
Author-email: me@marcanuy.com
License: UNKNOWN
Description: # Sitemap Builder
        
        Generate sitemaps from programmatically collected URLs.
        
        # Features
        
        - Generates an index that points to compressed sitemaps files
        - each generated sitemap won't have more than the allowed amount of
          50.000 URLs
        - jinja2 templates
        
        # Install
        
        ~~~
        pip install sitemap-builder
        ~~~
        
        # Usage
        
        1. Import 
        
        ~~~
        from sitemap import Sitemap
        ~~~
        
        2. Initialize
        
        ~~~
        sitemap = Sitemap()
        ~~~
        
        3. Add urls to process them later:
        
        ~~~
        sitemap.add_url("dummy-page")
        sitemap.add_url("another-page")
        sitemap.add_url("category/foo-bar")
        ~~~
        
        4. Generate sitemap index and files
        
        ~~~
        sitemap.generate()
        ~~~
        
        # Example:
        
        Generated files:
        
        ~~~
        .
        ├── sitemap.xml
        └── sitemaps
            ├── sitemap-0.xml.gz
            ├── sitemap-1.xml.gz
            ├── sitemap-2.xml.gz
        	└── sitemap-3.xml.gz
        ~~~
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
