naughty_string_validator

https://img.shields.io/pypi/v/naughty-string-validator.svg https://img.shields.io/pypi/pyversions/naughty-string-validator.svg https://travis-ci.org/shashikumarraja/naughty_string_validator_python.svg?branch=master https://codecov.io/gh/shashikumarraja/naughty_string_validator_python/branch/master/graph/badge.svg Updates https://pepy.tech/badge/naughty-string-validator https://img.shields.io/badge/License-MIT-blue.svg

A python library that returns naughty strings from an offline database of Big List of Naughty Strings and emojis. The db will be continuously growing with each release.

The Big List of Naughty Strings is an evolving list of strings which have a high probability of causing issues when used as user-input data.

This library can be inluded in the test automation framework for API, UI, or DB testing to validate them against naughty strings.

Installation

pip install naughty_string_validator

Usage

from naughty_string_validator import *
  • To get a random naughty string from the list
print(get_random_naughty_string())

#output
"<a href=\"\\xE2\\x80\\x88javascript…(1)\" id=\"fuzzelement1\">test</a>"
  • To get entire naughty string list
print(get_naughty_string_list())

#output
["", "undefined", "undef", "null", "NULL", "(null)", "nil", …]
  • To get a random emoji from the emoji list
print(get_random_emoji())

#output
"😃"
  • To get a entire emoji list
print(get_emoji_list())

#output
["😀", "😃", "😄", "😁", "😆", "😅", "😂", "🤣", "☺️", "😊", …]

Tests

  • To run tests

    py.test –cov=naughty_string_validator test/ –verbose

Contents:

Installation

At the command line either via easy_install or pip:

$ easy_install naughty_string_validator
$ pip install naughty_string_validator

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv naughty_string_validator
$ pip install naughty_string_validator

Usage

To use naughty_string_validator_python in a project:

import naughty_string_validator

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/shashikumarraja/naughty_string_validator_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” is open to whoever wants to implement it.

Implement Features

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

Write Documentation

naughty_string_validator_python could always use more documentation, whether as part of the official naughty_string_validator_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/shashikumarraja/naughty_string_validator_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 naughty_string_validator for local development.

  1. Fork the naughty_string_validator_python repo on GitHub.

  2. Clone your fork locally:

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

  3. Create a branch for local development:

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

Now you can make your changes locally.

  1. When you’re done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:

    $ tox

To get tox, just pip install it.

  1. 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

  2. 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, and 3.3, and for PyPy. Check https://travis-ci.org/shashikumarraja/naughty_string_validator_python under pull requests for active pull requests or run the tox command and make sure that the tests pass for all supported Python versions.
Tips

To run a subset of tests:

$ py.test test/test_naughty_string_validator.py

Credits

Development Lead
Contributors

None yet. Why not be the first?

History

0.1.7 (2020-05-07)
  • Minor improvements in code
  • Fixed bug introduced by 0.1.6 of utils not found while importing in python version 3
0.1.2 (2018-09-03)
  • Removed test code from build
0.1.0 (2018-09-03)
  • First release on PyPI.

Feedback

If you have any suggestions or questions about naughty_string_validator_python feel free to email me at shashiraja92@gmail.com.

If you encounter any errors or problems with naughty_string_validator_python, please let me know! Open an Issue at the GitHub https://github.com/shashikumarraja/naughty_string_validator_python main repository.