om-names


Nameom-names JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryAn API for naming things
upload_time2024-12-05 13:56:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseAGPL-3.0-or-later
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Names

An API for exploring the essence of naming \
![](image.jpeg)


## Getting started

It's easy to start developing locally:

1. Install [uv](https://docs.astral.sh/uv/):

  ```console
  $ curl -LsSf https://astral.sh/uv/install.sh | sh
  ```
2. Clone this repository:

  ```console
  $ git clone git@github.com:eidorb/names.git
  $ cd names
  ```
3. Generate some names:

  ```console
  $ uv run -m names "seedy"
  gravity
  postage
  salary
  lobster
  garden
  ```
4. 🙇

uv will find, install and update a suitable Python interpreter and Python package dependencies as required. It's pretty fast.

Alternatively, you could activate a shell in the environment:

```console
$ uv sync
$ source .venv/bin/activate
```

And run commands as usual:

```console
(om-names)$ python -m names --help

 Usage: names.py [OPTIONS] [SEED]

 Generates a random sequence of names, seeded with SEED.
 Name things in your collection using the same SEED. Increase --offset as the
 collection grows. (You can name up to 1633 things.)

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│   seed      [SEED]  Use a fixed seed to ensure names are shuffled in the     │
│                     same order. It can be any value, even nothing. Just be   │
│                     sure to remember it.                                     │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --count                     INTEGER             Returns this many names.     │
│                                                 [default: 5]                 │
│ --offset                    INTEGER             Skip over this many names.   │
│                                                 [default: 0]                 │
│ --format                    [text|python|json]  [default: text]              │
│ --install-completion                            Install completion for the   │
│                                                 current shell.               │
│ --show-completion                               Show completion for the      │
│                                                 current shell, to copy it or │
│                                                 customize the installation.  │
│ --help                                          Show this message and exit.  │
╰──────────────────────────────────────────────────────────────────────────────╯
```


Deactivate when you're done:

```console
(om-names)$ deactivate
$
```


## Quick links

From the command line.

- Actions

  ```shell
  open "https://github.com/eidorb/${PWD##*/}/actions"
  ```
- Actions secrets

  ```shell
  open "https://github.com/eidorb/${PWD##*/}/settings/secrets/actions"
  ```


## Some command line poetry

```console
$ echo "write the most insightful and terse poem you can about the difficulties of " \
     "naming things using these words (be sure to include a valid http url link):\n" \
     "$(uv run -m names)" \
  | uvx llm -m grok-beta
In the realm of naming, a **spirit** soars,
A **toga** of words, a **concert** of thoughts.
A **period** of struggle, a **ranger** explores,
For the perfect name, a battle is fought.

[Explore the essence of naming](https://en.wikipedia.org/wiki/Naming)
```

```mermaid
graph TD
    START:::hidden --> ?
    END --> ? --> START
    ? --> END:::hidden

    classDef hidden display: none;
```

> In the realm of naming, a **spirit** soars,\
> A **toga** of words, a **concert** of thoughts.\
> A **period** of struggle, a **ranger** explores,\
> For the perfect name, a battle is fought.
>
> [Explore the essence of naming](https://en.wikipedia.org/wiki/Naming)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "om-names",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "eidorb <brodieface@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f7/73/01587e770425508bdff9ee68cff0c996037a4b8fda8d44059dd7522d7ef2/om_names-0.1.0.tar.gz",
    "platform": null,
    "description": "# Names\n\nAn API for exploring the essence of naming \\\n![](image.jpeg)\n\n\n## Getting started\n\nIt's easy to start developing locally:\n\n1. Install [uv](https://docs.astral.sh/uv/):\n\n  ```console\n  $ curl -LsSf https://astral.sh/uv/install.sh | sh\n  ```\n2. Clone this repository:\n\n  ```console\n  $ git clone git@github.com:eidorb/names.git\n  $ cd names\n  ```\n3. Generate some names:\n\n  ```console\n  $ uv run -m names \"seedy\"\n  gravity\n  postage\n  salary\n  lobster\n  garden\n  ```\n4. \ud83d\ude47\n\nuv will find, install and update a suitable Python interpreter and Python package dependencies as required. It's pretty fast.\n\nAlternatively, you could activate a shell in the environment:\n\n```console\n$ uv sync\n$ source .venv/bin/activate\n```\n\nAnd run commands as usual:\n\n```console\n(om-names)$ python -m names --help\n\n Usage: names.py [OPTIONS] [SEED]\n\n Generates a random sequence of names, seeded with SEED.\n Name things in your collection using the same SEED. Increase --offset as the\n collection grows. (You can name up to 1633 things.)\n\n\u256d\u2500 Arguments \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502   seed      [SEED]  Use a fixed seed to ensure names are shuffled in the     \u2502\n\u2502                     same order. It can be any value, even nothing. Just be   \u2502\n\u2502                     sure to remember it.                                     \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --count                     INTEGER             Returns this many names.     \u2502\n\u2502                                                 [default: 5]                 \u2502\n\u2502 --offset                    INTEGER             Skip over this many names.   \u2502\n\u2502                                                 [default: 0]                 \u2502\n\u2502 --format                    [text|python|json]  [default: text]              \u2502\n\u2502 --install-completion                            Install completion for the   \u2502\n\u2502                                                 current shell.               \u2502\n\u2502 --show-completion                               Show completion for the      \u2502\n\u2502                                                 current shell, to copy it or \u2502\n\u2502                                                 customize the installation.  \u2502\n\u2502 --help                                          Show this message and exit.  \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n\nDeactivate when you're done:\n\n```console\n(om-names)$ deactivate\n$\n```\n\n\n## Quick links\n\nFrom the command line.\n\n- Actions\n\n  ```shell\n  open \"https://github.com/eidorb/${PWD##*/}/actions\"\n  ```\n- Actions secrets\n\n  ```shell\n  open \"https://github.com/eidorb/${PWD##*/}/settings/secrets/actions\"\n  ```\n\n\n## Some command line poetry\n\n```console\n$ echo \"write the most insightful and terse poem you can about the difficulties of \" \\\n     \"naming things using these words (be sure to include a valid http url link):\\n\" \\\n     \"$(uv run -m names)\" \\\n  | uvx llm -m grok-beta\nIn the realm of naming, a **spirit** soars,\nA **toga** of words, a **concert** of thoughts.\nA **period** of struggle, a **ranger** explores,\nFor the perfect name, a battle is fought.\n\n[Explore the essence of naming](https://en.wikipedia.org/wiki/Naming)\n```\n\n```mermaid\ngraph TD\n    START:::hidden --> ?\n    END --> ? --> START\n    ? --> END:::hidden\n\n    classDef hidden display: none;\n```\n\n> In the realm of naming, a **spirit** soars,\\\n> A **toga** of words, a **concert** of thoughts.\\\n> A **period** of struggle, a **ranger** explores,\\\n> For the perfect name, a battle is fought.\n>\n> [Explore the essence of naming](https://en.wikipedia.org/wiki/Naming)\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-or-later",
    "summary": "An API for naming things",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "97232ab5c7868f7d02df0dc83d12afa15c71f91f2c9be4ab31d498d0b0fe09dc",
                "md5": "9c80d4ec20f1550e647357df2ed19147",
                "sha256": "e7aaf25c19afa02ac69ad9bfad203c043e19f63af3dc802e161d941850e84494"
            },
            "downloads": -1,
            "filename": "om_names-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c80d4ec20f1550e647357df2ed19147",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 14236,
            "upload_time": "2024-12-05T13:56:52",
            "upload_time_iso_8601": "2024-12-05T13:56:52.169490Z",
            "url": "https://files.pythonhosted.org/packages/97/23/2ab5c7868f7d02df0dc83d12afa15c71f91f2c9be4ab31d498d0b0fe09dc/om_names-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f77301587e770425508bdff9ee68cff0c996037a4b8fda8d44059dd7522d7ef2",
                "md5": "12f422ee2be29fcd09d2d346e342497f",
                "sha256": "98a86eb9e5ff8ffde4233c4cb22103eb285b11509c0feaf7fb3c0abc7c7986ac"
            },
            "downloads": -1,
            "filename": "om_names-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "12f422ee2be29fcd09d2d346e342497f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 22535,
            "upload_time": "2024-12-05T13:56:54",
            "upload_time_iso_8601": "2024-12-05T13:56:54.606550Z",
            "url": "https://files.pythonhosted.org/packages/f7/73/01587e770425508bdff9ee68cff0c996037a4b8fda8d44059dd7522d7ef2/om_names-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-05 13:56:54",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "om-names"
}
        
Elapsed time: 0.39056s