https://github.com/zacharyvoase/slugify

A generic slugifier (currently only for Latin-based scripts).
https://github.com/zacharyvoase/slugify

Last synced: 3 months ago
JSON representation

A generic slugifier (currently only for Latin-based scripts).

• Host: GitHub
• URL: https://github.com/zacharyvoase/slugify
• Owner: zacharyvoase
• License: unlicense
• Created: 2010-12-07T14:35:51.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2023-05-11T07:55:26.000Z (over 2 years ago)
• Last Synced: 2024-11-13T06:43:08.618Z (11 months ago)
• Language: Python
• Homepage:
• Size: 123 KB
• Stars: 29
• Watchers: 4
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# `slugify`

`slugify` is a generic slugifier utility, inspired by Django’s `slugify`

template filter, packaged as a standalone Python library and command-line

application.

## Installation

    % [sudo] pip install slugify # OR

    % [sudo] easy_install slugify

## Usage

### Python

    >>> import slugify

    >>> slugify.slugify(u"Héllø Wörld")

    u"hello-world"

### Command-line

    % echo "Héllø Wörld" | slugify

    hello-world

## License

The parts of this application that I wrote are released into the public domain

via [The Unlicense](http://unlicense.org/).

The slugifying routine is derived from Django, and as such is BSD-licensed:

> Copyright (c) Django Software Foundation and individual contributors.

> All rights reserved.

>

> Redistribution and use in source and binary forms, with or without modification,

> are permitted provided that the following conditions are met:

>

>     1. Redistributions of source code must retain the above copyright notice,

>        this list of conditions and the following disclaimer.

>

>     2. Redistributions in binary form must reproduce the above copyright

>        notice, this list of conditions and the following disclaimer in the

>        documentation and/or other materials provided with the distribution.

>

>     3. Neither the name of Django nor the names of its contributors may be used

>        to endorse or promote products derived from this software without

>        specific prior written permission.

>

> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

> ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

> WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

> DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR

> ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

> (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

> LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON

> ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

> (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.