Skip to main content

![CI](https://github.com/hintofbasil/Python-Beautifurl/workflows/CI/badge.svg?branch=master)

# BeautifURL

## Installation

BeautifURL can be installed from pip

pip install beautifurl

## Usage

>>> from beautifurl import Beautifurl
>>> beautifurl = Beautifurl()
>>> beautifurl.get_random_url('aaA')
'BeautifulAdventurousGiraffe'
>>> beautifurl.count_permutations('aaA')
9150136
>>> for url in beautifurl.get_permutations('aaA', shuffle=True):
...     print(url)
...

GloriousDeterminedPeafowl NiceSuccessfulJackal DepressedStupidPartridge StormyStrangeGiraffe AngryPleasantMonkey …

### Url format

The examples above have a format string as their first argument. This dictates which types of words the url should be made up of. The examples all use adjective adjective Animal. Any number or combination of keys may be used. A full list of keys is available below.

### Custom dictionaries

The Beautifurl object __init__ function takes an optional parameter dictionaryPath. This allows the default dictionaries to be swapped for user specified dictionaries.

>>> beautifurl = Beautifurl(dictionaryPath='~/dictionaries')

The dictionaries in this folder must be named KEY_… where KEY is a single character. All keys should be unique. Any characters after the underscore are ignored. See dictionaries folder for examples.

## Dictionaries

Key | Description | Size |
— | ———– | —- |
a | Adjectives | 223 |
A | Animals | 211 |

## Contributing

### Wordlists

Additional words and lists may be submitted in pull requests. Please run the new lists through the organise script located in the dictionaries folder.

Please ensure you have permission to use any lists before submitting a pull request. If a license is required please name the license file license.LIST_NAME.

./organise LIST_NAME [MAX_SIZE] > tmp mv tmp LIST_NAME

### Code

Pull requests are more than welcome.

Metadata

Release files for beautifurl 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for beautifurl 0.1.4
File Size Uploaded Provenance Actions
beautifurl-0.1.4.tar.gz 6.0 kB Without provenance Details for beautifurl-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for beautifurl 0.1.4
File Interpreter ABI Platform Actions
beautifurl-0.1.4-py3-none-any.whl Python 3 none any Details for beautifurl-0.1.4-py3-none-any.whl

Total release size: 15.0 kB

Release files / beautifurl-0.1.4.tar.gz

Download URL beautifurl-0.1.4.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
cd0306bf45b400f0db2c8d9e1a5803738dad2461ba2ff9ce84f40f49f26b3be5
BLAKE2b-256 checksum
How to use checksums
710ed5da4db63f8c7077921ff65cde1f87b85febaaa222ba8fe65445f99b75b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

Release files / beautifurl-0.1.4-py3-none-any.whl

Download URL beautifurl-0.1.4-py3-none-any.whl
Size 9.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0b1462d5f7a8c5b1dc8f690972996c7de7e1d2b9f6e874322faacf68ab795e1a
BLAKE2b-256 checksum
How to use checksums
22b973f38817f455d90ca18f5d6c80ac9ad3c3430c9eee74e90a1d0ba6fc1f3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

Security for beautifurl 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page