django-hidden-models


Namedjango-hidden-models JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/bigcrazyfrog/django-hidden-models
SummarySimply hiding a useless data from query results
upload_time2023-09-16 12:43:19
maintainer
docs_urlNone
authorNikita Cibin
requires_python>=3.8
licenseBSD
keywords django hidden hide visible models
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            ====================
django-hidden-models
====================

.. image:: https://github.com/bigcrazyfrog/django-hidden-models/actions/workflows/tests.yaml/badge.svg
   :target: https://github.com/bigcrazyfrog/django-hidden-models/actions/
.. image:: https://coveralls.io/repos/bigcrazyfrog/django-hidden-models/badge.png
    :target: https://coveralls.io/r/bigcrazyfrog/django-hidden-models

Simply hiding a useless data from query results.

Status: developing

Example
-------

.. code-block:: python

    # imports
    from hidden_models.models import VisibleModel
    from django.db import models

    # Models
    class Article(VisibleModel):
        name = models.CharField(max_length=100)


    # Example of use

    >>> Article.objects.create(name='article1')
    >>> Article.objects.create(name='article2')
    
    >>> Article.objects.all() # Queryset [<Article: (1)>, <Article: (2)>]
    
    # This article will be hided, but not deleted from the database
    >>> Article.objects.filter(name='article1').hide()

    >>> Article.objects.all() # Queryset [<Article: (2)>]


Installation
------------

Installing from pypi (using pip). ::

    pip install django-hidden-models

Add ``hidden_models`` in your ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        'hidden_models',
        [...]
    ]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bigcrazyfrog/django-hidden-models",
    "name": "django-hidden-models",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "django,hidden,hide,visible,models",
    "author": "Nikita Cibin",
    "author_email": "cibinnikita@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a0/75/9268bc7ad185acdd9b59895584a452afd68ce3fd437bea39267edcc969d7/django-hidden-models-0.1.0.tar.gz",
    "platform": null,
    "description": "====================\r\ndjango-hidden-models\r\n====================\r\n\r\n.. image:: https://github.com/bigcrazyfrog/django-hidden-models/actions/workflows/tests.yaml/badge.svg\r\n   :target: https://github.com/bigcrazyfrog/django-hidden-models/actions/\r\n.. image:: https://coveralls.io/repos/bigcrazyfrog/django-hidden-models/badge.png\r\n    :target: https://coveralls.io/r/bigcrazyfrog/django-hidden-models\r\n\r\nSimply hiding a useless data from query results.\r\n\r\nStatus: developing\r\n\r\nExample\r\n-------\r\n\r\n.. code-block:: python\r\n\r\n    # imports\r\n    from hidden_models.models import VisibleModel\r\n    from django.db import models\r\n\r\n    # Models\r\n    class Article(VisibleModel):\r\n        name = models.CharField(max_length=100)\r\n\r\n\r\n    # Example of use\r\n\r\n    >>> Article.objects.create(name='article1')\r\n    >>> Article.objects.create(name='article2')\r\n    \r\n    >>> Article.objects.all() # Queryset [<Article: (1)>, <Article: (2)>]\r\n    \r\n    # This article will be hided, but not deleted from the database\r\n    >>> Article.objects.filter(name='article1').hide()\r\n\r\n    >>> Article.objects.all() # Queryset [<Article: (2)>]\r\n\r\n\r\nInstallation\r\n------------\r\n\r\nInstalling from pypi (using pip). ::\r\n\r\n    pip install django-hidden-models\r\n\r\nAdd ``hidden_models`` in your ``INSTALLED_APPS``:\r\n\r\n.. code-block:: python\r\n\r\n    INSTALLED_APPS = [\r\n        'hidden_models',\r\n        [...]\r\n    ]\r\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Simply hiding a useless data from query results",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/bigcrazyfrog/django-hidden-models"
    },
    "split_keywords": [
        "django",
        "hidden",
        "hide",
        "visible",
        "models"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9aee26f34367af0ad4bdf70949997820a8895d5b4ab2c6cc7892dc747847fee2",
                "md5": "c4c4bf325acab80d63c09ca84a5306ff",
                "sha256": "d4c3609eb49dbb38c7f17d923ef50fede9a72270882cf76e911493573d7e9f28"
            },
            "downloads": -1,
            "filename": "django_hidden_models-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c4c4bf325acab80d63c09ca84a5306ff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 10544,
            "upload_time": "2023-09-16T12:43:18",
            "upload_time_iso_8601": "2023-09-16T12:43:18.052932Z",
            "url": "https://files.pythonhosted.org/packages/9a/ee/26f34367af0ad4bdf70949997820a8895d5b4ab2c6cc7892dc747847fee2/django_hidden_models-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a0759268bc7ad185acdd9b59895584a452afd68ce3fd437bea39267edcc969d7",
                "md5": "574bbce13ce0733f0d88750952001390",
                "sha256": "ddfafec8fc4580bd04fda7e385f0e601faa7c6c1e62faa39c9eccefbd6409a02"
            },
            "downloads": -1,
            "filename": "django-hidden-models-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "574bbce13ce0733f0d88750952001390",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5035,
            "upload_time": "2023-09-16T12:43:19",
            "upload_time_iso_8601": "2023-09-16T12:43:19.849754Z",
            "url": "https://files.pythonhosted.org/packages/a0/75/9268bc7ad185acdd9b59895584a452afd68ce3fd437bea39267edcc969d7/django-hidden-models-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-16 12:43:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bigcrazyfrog",
    "github_project": "django-hidden-models",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "django-hidden-models"
}
        
Elapsed time: 0.77360s