Metadata-Version: 2.1
Name: oarepo-sitemaps
Version: 1.0.0
Summary: OARepo rdm records data model
Home-page: https://github.com/oarepo/oarepo-dc
Author: Alzbeta Pokorna
Author-email: alzbeta.pokorna@cesnet.cz
License: MIT
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: oarepo-mapping-includes
Requires-Dist: oarepo-records-draft
Requires-Dist: oarepo-communities
Requires-Dist: oarepo-invenio-model
Requires-Dist: flask-sitemap
Provides-Extra: tests
Requires-Dist: oarepo[tests] (~=3.3.0) ; extra == 'tests'
Requires-Dist: oarepo-records-draft ; extra == 'tests'
Requires-Dist: oarepo-actions ; extra == 'tests'
Requires-Dist: oarepo-validate ; extra == 'tests'
Requires-Dist: coverage ; extra == 'tests'
Requires-Dist: oarepo-mapping-includes ; extra == 'tests'
Requires-Dist: werkzeug (==1.0.1) ; extra == 'tests'
Requires-Dist: flask (==1.1.4) ; extra == 'tests'

OARepo sitemaps
====================
[![image][]][1]
[![image][2]][3]
[![image][4]][5]
[![image][6]][7]

Instalation
----------
```bash
    pip install oarepo-sitemaps
```

Usage
----------
OARepo module that creates sitemap for a repository. Sitemap includes only records, that are in state "published" and can be viewed by public. 
Created sitemap is accessible on ```server/sitemap.xml``` url.

Configuration
-------------
Default number of record per one sitemap is 10000, this can be changed in configuration with ```'SITEMAP_MAX_URL_COUNT``` set to a different number.

Example
-------
```xml
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
 <url>
  <loc>http://localhost:5000/cesnet/records/1</loc>
  <lastmod>2021-05-24</lastmod>
  <changefreq>weakly</changefreq>
  <priority>1</priority>
 </url>
 <url>
  <loc>http://localhost:5000/cesnet/records/2</loc>
  <lastmod>2021-05-24</lastmod>
  <changefreq>weakly</changefreq>
  <priority>1</priority>
 </url>
</urlset>
```
 [image]: https://img.shields.io/travis/oarepo/oarepo-sitemaps.svg
  [1]: https://travis-ci.com/github/oarepo/oarepo-sitemaps
  [2]: https://img.shields.io/coveralls/oarepo/oarepo-sitemaps.svg
  [3]: https://coveralls.io/r/oarepo/oarepo-sitemaps
  [4]: https://img.shields.io/github/license/oarepo/oarepo-sitemaps.svg
  [5]: https://github.com/oarepo/oarepo-documents/blob/master/LICENSE
  [6]: https://img.shields.io/pypi/v/oarepo-sitemaps.svg
  [7]: https://pypi.org/pypi/oarepo-sitemaps

<!--
Copyright (C) 2020 CESNET z.s.p.o.

oarepo-sitemaps is free software; you can redistribute it and/or modify it
under the terms of the MIT License; see LICENSE file for more details.
-->

# Changes 

## Version 1.0.0 

- Initial public release.


