langbank

Name	langbank JSON
Version	0.2.1 JSON
	download
home_page	https://github.com/tebby24/langbank
Summary	A simple word bank for language learning
upload_time	2024-04-17 02:46:31
maintainer	None
docs_url	None
author	Teddy Gonyea
requires_python	None
license	None
keywords	language learning
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # LangBank

LangBank is a Python package for managing a word bank for language learning. It provides functionality for storing and retrieving words along with additional information such as timestamps and tags.

## Installation

```bash
pip install langbank
```

## Usage

### LangBank class

```python
from langbank import LangBank

# Initialize a LangBank instance
lb = LangBank()

# Add a word to the bank with optional tags
lb.add_word("hello", tags=["greeting", "basic"])

# Get all words in the bank
words = lb.get_all_words()

# Get all unique words in the bank
unique_words = lb.get_all_unique_words()

# Get words added in the past n days
recent_words = lb.get_words_from_past_n_days(7)

# Get words added today
todays_words = lb.get_todays_words()

# Get words by a specific tag
greeting_words = lb.get_words_by_tag("greeting")

# Get words added on a specific date
from datetime import date
words_on_date = lb.get_words_by_date(date(2021, 12, 31))

# Get the number of times a word has been added
occurrences = lb.occurences("hello")
```

### ReviewList class

```python
from langbank import ReviewList

# Initialize a ReviewList instance
rl = ReviewList()

# Set a new file path
rl.set_file_path("~/new_path/review_list.txt")

# Add a new word
rl.add_word("hello")

# Check if the review list is full
is_full = rl.is_full()

# Get the review list
review_list = rl.get_list()
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tebby24/langbank",
    "name": "langbank",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "language learning",
    "author": "Teddy Gonyea",
    "author_email": "enterted@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/0b/e5/86ff1040b05ea937d2b9595e33cff20de96c9ba12521485d35556ba43e39/langbank-0.2.1.tar.gz",
    "platform": null,
    "description": "# LangBank\n\nLangBank is a Python package for managing a word bank for language learning. It provides functionality for storing and retrieving words along with additional information such as timestamps and tags.\n\n## Installation\n\n```bash\npip install langbank\n```\n\n## Usage\n\n### LangBank class\n\n```python\nfrom langbank import LangBank\n\n# Initialize a LangBank instance\nlb = LangBank()\n\n# Add a word to the bank with optional tags\nlb.add_word(\"hello\", tags=[\"greeting\", \"basic\"])\n\n# Get all words in the bank\nwords = lb.get_all_words()\n\n# Get all unique words in the bank\nunique_words = lb.get_all_unique_words()\n\n# Get words added in the past n days\nrecent_words = lb.get_words_from_past_n_days(7)\n\n# Get words added today\ntodays_words = lb.get_todays_words()\n\n# Get words by a specific tag\ngreeting_words = lb.get_words_by_tag(\"greeting\")\n\n# Get words added on a specific date\nfrom datetime import date\nwords_on_date = lb.get_words_by_date(date(2021, 12, 31))\n\n# Get the number of times a word has been added\noccurrences = lb.occurences(\"hello\")\n```\n\n### ReviewList class\n\n```python\nfrom langbank import ReviewList\n\n# Initialize a ReviewList instance\nrl = ReviewList()\n\n# Set a new file path\nrl.set_file_path(\"~/new_path/review_list.txt\")\n\n# Add a new word\nrl.add_word(\"hello\")\n\n# Check if the review list is full\nis_full = rl.is_full()\n\n# Get the review list\nreview_list = rl.get_list()\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple word bank for language learning",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/tebby24/langbank"
    },
    "split_keywords": [
        "language",
        "learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0be586ff1040b05ea937d2b9595e33cff20de96c9ba12521485d35556ba43e39",
                "md5": "0252df7eb398304597f6649e85d836c3",
                "sha256": "5e397578d4680545b82ae883dfefadcebb3a860256d9815d1e98d4d070d2c7ea"
            },
            "downloads": -1,
            "filename": "langbank-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0252df7eb398304597f6649e85d836c3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3728,
            "upload_time": "2024-04-17T02:46:31",
            "upload_time_iso_8601": "2024-04-17T02:46:31.694201Z",
            "url": "https://files.pythonhosted.org/packages/0b/e5/86ff1040b05ea937d2b9595e33cff20de96c9ba12521485d35556ba43e39/langbank-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-17 02:46:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tebby24",
    "github_project": "langbank",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "langbank"
}