Metadata-Version: 2.1
Name: llms-txt
Version: 0.0.1
Summary: The /llms.txt file, helping language models use your website
Home-page: https://github.com/AnswerDotAI/llms-txt
Author: Jeremy Howard
Author-email: github@jhoward.fastmail.fm
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python LLMs NLP
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastcore
Provides-Extra: dev

# llms-txt


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

This file will become your README and also the index of your
documentation.

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Setup

It can be helpful to have a dedicated environment for development. Here
we are assuming that you have an conda environment file called `env.yml`
named after `llms_txt` i.e.:

``` yaml
# env.yml
name: llms_txt

channels:
  - fastai

dependencies:
  - fastai::nbdev>=2.3.12
# - python>=3.11  # specify python version if required 
# - dependency 1
# - dependency 2
# - pip
# pip:
#   - pip dependency 1
#   - pip dependency 2
```

You can then use `conda` or `mamba` (faster at resolving) to create and
update your environment file should your needs change as you work on
`llms_txt`

``` sh
# create a conda environment for working on llms-txt
$ mamba env create -f env.yml

# update conda environment
$ mamba env update -n llms_txt --file env.yml
```

### Install llms_txt in Development mode

``` sh
# activate conda environment
$ conda activate llms_txt

# make sure llms_txt package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to llms_txt
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/AnswerDotAI/llms-txt):

``` sh
$ pip install git+https://github.com/AnswerDotAI/llms-txt.git
```

or from [conda](https://anaconda.org/AnswerDotAI/llms-txt)

``` sh
$ conda install -c AnswerDotAI llms_txt
```

or from [pypi](https://pypi.org/project/llms-txt/)

``` sh
$ pip install llms_txt
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/AnswerDotAI/llms-txt)’s
[pages](https://AnswerDotAI.github.io/llms-txt/). Additionally you can
find package manager specific guidelines on
[conda](https://anaconda.org/AnswerDotAI/llms-txt) and
[pypi](https://pypi.org/project/llms-txt/) respectively.

## How to use

Fill me in please! Don’t forget code examples:

``` python
1+1
```

    2
