Metadata-Version: 2.1
Name: portal-core
Version: 0.1.0
Summary: portal core
Home-page: https://github.com/kacotam-si/portal-core
Author: Kacotam Si Team
Author-email: si-team@kacotam.com
License: MIT
Keywords: Django
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
License-File: LICENSE

===============
portal-core
===============

.. image:: https://github.com/kacotam-si/portal-core/actions/workflows/django.yml/badge.svg?branch=master
    :target: https://github.com/kacotam-si/portal-core/actions/workflows/django.yml
    :alt: Django CI

.. image:: https://coveralls.io/repos/github/kacotam-si/portal-core/badge.svg?branch=master
    :target: https://coveralls.io/github/kacotam-si/portal-core?branch=master
    :alt: COVERALLS

.. image:: https://codeclimate.com/github/kacotam-si/portal-core/badges/gpa.svg
   :target: https://codeclimate.com/github/kacotam-si/portal-core
   :alt: Code Climate

.. image:: https://codeclimate.com/github/kacotam-si/portal-core/badges/issue_count.svg
   :target: https://codeclimate.com/github/kacotam-si/portal-core
   :alt: Issue Count

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: https://raw.githubusercontent.com/kacotam-si/portal-core/master/LICENSE
   :alt: LICENSE MIT


**portal-core** is Portal System Core functions.


Requirement
============

* Python >= 3.6
* Django >= 3.2


Quick start
============

1. Install by pip ::

    # install from github master branch
    pip install -U https://github.com/kacotam-si/portal-core/archive/master.tar.gz


2. Add "portal_core" to INSTALLED_APPS ::

    INSTALLED_APPS = [
        ...
        'portal_core',
        ...
    ]


3. Set Valuse in settings ::

    #

4. Usage ::

    import portal_core

Acknowledgements
=================

CHANGELOG
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a
Changelog <http://keepachangelog.com/en/1.0.0/>`__ and this project
adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`__.

[Unreleased] - 0000-00-00
-------------------------

Added
~~~~~

* ...

Changed
~~~~~~~

* ...

Deprecated
~~~~~~~~~~

* ...

Removed
~~~~~~~

* ...

Fixed
~~~~~

* ...

Security
~~~~~~~~

* ...

The MIT License (MIT)

Copyright (c) 2019 Kacotam System Integration Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


