{"id":13585633,"url":"https://github.com/proycon/clam","last_synced_at":"2025-05-16T12:12:12.377Z","repository":{"id":57092679,"uuid":"760072","full_name":"proycon/clam","owner":"proycon","description":"Quickly turn command-line applications into RESTful webservices with a web-application front-end. You provide a specification of your command line application, its input, output and parameters, and CLAM wraps around your application to form a fully fledged RESTful webservice.","archived":false,"fork":false,"pushed_at":"2025-03-12T12:22:57.000Z","size":26631,"stargazers_count":130,"open_issues_count":14,"forks_count":17,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-10T01:08:54.784Z","etag":null,"topics":["nlp","python","rest","webservice","wrapper"],"latest_commit_sha":null,"homepage":"https://proycon.github.io/clam","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/proycon.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2010-07-06T17:15:18.000Z","updated_at":"2025-04-24T13:17:55.000Z","dependencies_parsed_at":"2024-03-16T15:31:56.384Z","dependency_job_id":null,"html_url":"https://github.com/proycon/clam","commit_stats":{"total_commits":2369,"total_committers":7,"mean_commits":"338.42857142857144","dds":0.005487547488391753,"last_synced_commit":"0ebcbe2c711d247932af98093a698e720da02eca"},"previous_names":[],"tags_count":91,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proycon%2Fclam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proycon%2Fclam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proycon%2Fclam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/proycon%2Fclam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/proycon","download_url":"https://codeload.github.com/proycon/clam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254527099,"owners_count":22085919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nlp","python","rest","webservice","wrapper"],"created_at":"2024-08-01T15:05:03.192Z","updated_at":"2025-05-16T12:12:12.348Z","avatar_url":"https://github.com/proycon.png","language":"Python","readme":"=======================================================\nCLAM: Computational Linguistics Application Mediator\n=======================================================\n\n.. image:: https://github.com/proycon/clam/actions/workflows/clam.yml/badge.svg?branch=master\n    :target: https://github.com/proycon/clam/actions/\n\n.. image:: https://readthedocs.org/projects/clam/badge/?version=latest\n    :target: http://clam.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://zenodo.org/badge/760072.svg\n   :target: https://zenodo.org/badge/latestdoi/760072\n\n.. image:: https://img.shields.io/pypi/v/clam\n   :alt: Latest release in the Python Package Index\n   :target: https://pypi.org/project/clam/\n\n.. image:: http://applejack.science.ru.nl/lamabadge.php/clam\n   :target: http://applejack.science.ru.nl/languagemachines/\n\n.. image:: https://www.repostatus.org/badges/latest/active.svg\n   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.\n   :target: https://www.repostatus.org/#active\n\n\n*by Maarten van Gompel*\n*Centre for Language and Speech Technology, Radboud University Nijmegen*\n*\u0026 KNAW Humanities Cluster*\n\n*Licensed under GPLv3*\n\n**Website:** https://proycon.github.io/clam\n**Source repository:** https://github.com/proycon/clam/\n**Documentation:** https://clam.readthedocs.io\n**Installation:** ``pip install clam``\n\nCLAM allows you to quickly and transparently transform your Natural Language\nProcessing application into a RESTful webservice, with which both human\nend-users as well as automated clients can interact. CLAM takes a description\nof your system and wraps itself around the system, allowing end-users or\nautomated clients to upload input files to your application, start your\napplication with specific parameters of their choice, and download and view the\noutput of the application once it is completed.\n\nCLAM is set up in a universal fashion, requiring minimal effort on the part of\nthe service developer. Your actual NLP application is treated as a black box,\nof which only the parameters, input formats and output formats need to be\ndescribed. Your application itself needs not be network aware in any way, nor\naware of CLAM, and the handling and validation of input can be taken care of by\nCLAM.\n\nCLAM is entirely written in Python, runs on UNIX-derived systems, and is\navailable as open source under the GNU Public License (v3). It is set up in a\nmodular fashion, and offers an API, and as such is easily extendable. CLAM\ncommunicates in a transparent XML format, and using XSL transformation offers a\nmodern client-side generated web-interface for human end users.\n\n\nDocumentation\n---------------\n\nDocumentation is available on https://clam.readthedocs.io\n\nSome screenshots of the web user interface can be found below:\n\n.. image:: https://raw.githubusercontent.com/proycon/clam/master/docs/screenshot.png\n    :alt: the clam project list\n\n.. image:: https://raw.githubusercontent.com/proycon/clam/master/docs/screenshot2.png\n    :alt: the clam project page during staging\n\n.. image:: https://raw.githubusercontent.com/proycon/clam/master/docs/screenshot3.png\n    :alt: the clam project page when done\n\n\nInstallation\n----------------\n\nInstallation from the Python Package Index using the  package manager *pip* it the recommended way to\nintall CLAM. This is the easiest method\nof installing CLAM, as it will automatically fetch and install any\ndependencies. We recommend to use a virtual environment (``virtualenv``) if you\nwant to install CLAM locally as a user, if you want to install globally,\nprepend the following commands with ``sudo``:\n\nCLAM can be installed from the Python Package Index using pip. Pip is usually\npart of the ``python3-pip`` package (Debian/Ubuntu) or similar, note that\nPython 2.7 is not supported anymore (you might need to call ``pip3`` instead of ``pip`` on older system). It downloads CLAM and all dependencies\nautomatically:::\n\n  $ pip install clam\n\nIf you already downloaded CLAM manually (from github), you can do::\n\n  $ pip install .\n\nIf pip is not yet installed on your system, install it using:\n on debian-based linux systems (including Ubuntu)::\n\n  $ apt-get install python3-pip\n\non RPM-based linux systems::\n\n  $ yum install python3-pip\n\nNote that sudo/root access is needed to install globally. Ask your system administrator\nto install it if you do not own the system. Alternatively, you can install it locally in a Python virtual\nenvironment::\n\n  $ virtualenv --python=python3 env\n\nOr::\n\n  $ python3 -m venv env\n\nThen activate it as follows:\n\n  $ . env/bin/activate\n\n  (env)$ pip install clam\n\nCLAM also has some optional dependencies. For MySQL support, install\n``mysqlclient`` using pip. For `FoLiA \u003chttps://proycon.github.io/folia\u003e`_\nsupport, install ``FoLiA-Tools`` using pip.\n\n**Note:** CLAM is designed for Linux-like systems, although the client and data library work everywhere, hosting webservices via ``clamservice`` may not work on Windows.\n\nRunning a test webservice\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf you installed CLAM using the above method, then you can launch a clam test\nwebservice using the development server as follows::\n\n  $ clamservice -H localhost -p 8080 clam.config.textstats\n\nNavigate your browser to http://localhost:8080 and verify everything works\n\n**Note:** It is important to regularly keep CLAM up to date as fixes and\nimprovements are implemented on a regular basis. Update CLAM using::\n\n  $ pip install -U clam\n\n\n","funding_links":[],"categories":["Python","Software"],"sub_categories":["Utilities"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproycon%2Fclam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproycon%2Fclam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproycon%2Fclam/lists"}