Welcome to iam-profile-faker’s documentation!

iam-profile-faker

https://img.shields.io/pypi/v/iam_profile_faker.svg https://img.shields.io/travis/mozilla-iam/iam-profile-faker.svg Documentation Status

JSON generator based on IAM profile v2 schema

Features

  • Create fake profile v2 objects
  • Batch create fake profile v2 objects
  • CLI to export profile v2 objects in JSON.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install iam-profile-faker, run this command in your terminal:

$ pip install iam_profile_faker

This is the preferred method to install iam-profile-faker, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for iam-profile-faker can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/mozilla-iam/iam-profile-faker

Or download the tarball:

$ curl  -OL https://github.com/mozilla-iam/iam-profile-faker/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use iam-profile-faker in a project:

from iam_profile_faker.factory import V2ProfileFactory


factory = V2ProfileFactory()
# Generate a single object
factory.create()

# Generate a batch of 10 objects
factory.create_batch(10)

# Generate a single object serialized to JSON
factory.create(export_json=True)

# Generate a batch of 10 objects serialized to JSON
factory.create_batch(10, export_json=True)

To use iam-profile-faker as a CLI tool:

$ iam_profile_faker --help
Usage: iam_profile_faker [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
create        Create single IAM profile v2 object.
create_batch  Create batch IAM profile v2 objects.

iam_profile_faker

iam_profile_faker package

Submodules

iam_profile_faker.cli module

Console script for iam_profile_faker.

iam_profile_faker.factory module

class iam_profile_faker.factory.IAMFaker(locale=None, hierarchy=None)[source]

Bases: object

access_information()[source]

Profile v2 access information faker.

create()[source]

Method to generate fake profile v2 objects.

get_public_email_address()[source]
hris()[source]

Profile v2 HRIS faker

identities()[source]

Profile v2 identities faker.

languages(**kwargs)[source]
login_method(**kwargs)[source]
metadata(display=['public', 'authenticated', 'vouched', 'ndaed', 'staff', 'private'], c12n='WORKGROUP CONFIDENTIAL')[source]

Generate field metadata

office_location()[source]

Profile v2 office location faker.

pgp_public_keys(**kwargs)[source]
phone_numbers(**kwargs)[source]
pronouns(**kwargs)[source]
schema()[source]

Profile v2 schema faker.

signature()[source]

Generate field signature

ssh_public_keys(**kwargs)[source]
staff_information(hris)[source]

Profile v2 staff information faker

uris(**kwargs)[source]
user_id(**kwargs)[source]
usernames(**kwargs)[source]
class iam_profile_faker.factory.V2ProfileFactory[source]

Bases: object

create(export_json=False)[source]

Generate fake profile v2 object.

create_batch(count, export_json=False)[source]

Generate batch fake profile v2 objects.

iam_profile_faker.factory.create_random_hierarchy_iter()[source]

Generate hierarchy iterator with a random pattern

iam_profile_faker.factory.decorate_metadata_signature(display=['public', 'authenticated', 'vouched', 'ndaed', 'staff', 'private'], c12n='WORKGROUP CONFIDENTIAL')[source]
iam_profile_faker.factory.wrap_metadata_signature(obj, value, display=['public', 'authenticated', 'vouched', 'ndaed', 'staff', 'private'], c12n='WORKGROUP CONFIDENTIAL')[source]

Wrap profile value with metadata/signature

Module contents

Top-level package for iam-profile-faker.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/mozilla-iam/iam-profile-faker/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

iam-profile-faker could always use more documentation, whether as part of the official iam-profile-faker docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/mozilla-iam/iam-profile-faker/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up iam_profile_faker for local development.

  1. Fork the iam_profile_faker repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/iam_profile_faker.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv iam_profile_faker
$ cd iam_profile_faker/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 iam_profile_faker tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/mozilla-iam/iam-profile-faker/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_iam_profile_faker

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.3.0 (2018-07-19)

  • Fix factory to wrap values with metadata/signature
  • Fix value/values key name in various attributes
  • Add E2E to tests to validate objects against profile v2
  • Expose a service that generates fake profiles as HTTP API

0.2.0 (2018-07-13)

  • Add factory to generate fake iam profiles
  • Add cli to generate fake iam profiles

0.1.0 (2018-07-10)

  • Bootstrap repository

Indices and tables