Metadata-Version: 2.1
Name: bpmappers
Version: 1.3
Summary: bpmappers is a Python moudle that maps Python dictionary values and object properties to different dictionary.
Home-page: https://bpmappers.readthedocs.io/ja/stable/
Author: BeProud Inc.
Author-email: tokibito@gmail.com
License: MIT License
Keywords: model,mapper,django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
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 :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
Provides-Extra: develop
Requires-Dist: Django ; extra == 'develop'
Requires-Dist: pytest ; extra == 'develop'
Requires-Dist: flake8 ; extra == 'develop'
Requires-Dist: pytest-django ; extra == 'develop'
Requires-Dist: pytest-pythonpath ; extra == 'develop'
Requires-Dist: tox ; extra == 'develop'
Provides-Extra: django
Requires-Dist: Django ; extra == 'django'

=========
bpmappers
=========

|build-status| |pypi| |docs|

bpmappers is a Python moudle that maps Python dictionary values and object properties to different dictionary.

Install
=======

Install using pip.

::

   $ pip install bpmappers

Usage
=====

An example of mapping an instance of the Person class to a dictionary:

.. code-block:: pycon

   >>> class Person:
   ...     def __init__(self, name, age):
   ...         self.name = name
   ...         self.age = age
   ...     def __repr__(self):
   ...         return "<Person name={}, age={}>".format(self.name, self.age)
   ...
   >>> p = Person("Spam", 25)
   >>> p
   <Person name=Spam, age=25>
   >>> from bpmappers import Mapper, RawField
   >>> class PersonMapper(Mapper):
   ...     mapped_name = RawField('name')
   ...     mapped_age = RawField('age')
   ...
   >>> PersonMapper(p).as_dict()
   OrderedDict([('mapped_name', 'Spam'), ('mapped_age', 25)])

Requirements
============

- Target Python version is 3.6, 3.7, 3.8, 3.9
- Django 2.2, 3.0, 3.1 (When use Django support)

License
=======

This software is licensed under the MIT License.

Documentation
=============

The latest documentation is hosted at Read The Docs.

https://bpmappers.readthedocs.io/ja/stable/

Develop
=======

- This project is hosted at GitHub: https://github.com/beproud/bpmappers
- Release Procedure: https://github.com/beproud/bpmappers/blob/master/release_checklist.rst

Author
======

- BeProud, Inc

Maintainer
==========

- Shinya Okano <tokibito@gmail.com>

.. |build-status| image:: https://github.com/beproud/bpmappers/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/beproud/bpmappers/actions
.. |docs| image:: https://readthedocs.org/projects/bpmappers/badge/?version=stable
   :target: https://bpmappers.readthedocs.io/ja/stable/
.. |pypi| image:: https://badge.fury.io/py/bpmappers.svg
   :target: http://badge.fury.io/py/bpmappers


