Welcome to the Robtex Python documentation!

Contents:

Robtex Python

Simple python wrapper for the Robtex API . This project is currently under development. Feel free to contribute and don’t forget to add yourself to the AUTHORS.rst file!

• Free software: MIT license
• Documentation: https://robtex-python.readthedocs.io

Installation

Stable release

To install Robtex Python, run this command in your terminal:

pip install robtex-python

This is the preferred method to install the Robtex API wrapper, 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 Robtex Python can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/fhightower/robtex-python

Or download the tarball:

$ curl  -OL https://github.com/fhightower/robtex-python/tarball/master

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

$ python3 setup.py install

Usage

Via Python

You can use Robtex Python in a script as follows:

import robtex_python
response = robtex_python.pdns_forward("example.com")

Via Command Line

You can use Robtex Python as a command-line tool as follows:

Usage:
    robtex_python --ip=<ip>
    robtex_python --as=<asn>
    robtex_python --pdns-forward=<hostname>
    robtex_python --pdns-reverse=<ip>
    robtex_python (-h | --help)
    robtex_python --version

Credits

This package was created with Cookiecutter and the fhightower/python-project-template project template.

Installation

Stable release

To install Robtex Python, run this command in your terminal:

$ pip install robtex_python

This is the preferred method to install Robtex Python, 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 Robtex Python can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/fhightower/robtex-python

Or download the tarball:

$ curl  -OL https://github.com/fhightower/robtex-python/tarball/master

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

$ python setup.py install

Usage

To use Robtex Python in a project:

import robtex_python

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/fhightower/robtex-python/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

Robtex Python could always use more documentation, whether as part of the official Robtex Python 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/fhightower/robtex-python/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 robtex_python for local development.

1. Fork the robtex_python repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:<your_github_username_here>/robtex_python.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 robtex_python
   $ cd robtex_python/
   $ 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 robtex_python 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.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/fhightower/robtex-python/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_robtex_python

Credits

Development Lead

• Floyd Hightower

Contributors

None yet. Why not be the first?

History

0.1.0 (2017-09-19)

• First release on PyPI.

Indices and tables

• Index
• Module Index
• Search Page