{"id":16581587,"url":"https://github.com/andresmweber/nomenclate-api-python","last_synced_at":"2025-08-22T05:35:50.934Z","repository":{"id":38734859,"uuid":"362107093","full_name":"AndresMWeber/nomenclate-api-python","owner":"AndresMWeber","description":"An API for Nomenclate created using Serverless, Python and MongoDB","archived":false,"fork":false,"pushed_at":"2023-01-24T05:12:44.000Z","size":1537,"stargazers_count":0,"open_issues_count":18,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-13T06:41:23.938Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AndresMWeber.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-27T12:38:11.000Z","updated_at":"2021-06-29T16:29:48.000Z","dependencies_parsed_at":"2023-02-13T18:02:21.048Z","dependency_job_id":null,"html_url":"https://github.com/AndresMWeber/nomenclate-api-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AndresMWeber/nomenclate-api-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndresMWeber%2Fnomenclate-api-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndresMWeber%2Fnomenclate-api-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndresMWeber%2Fnomenclate-api-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndresMWeber%2Fnomenclate-api-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndresMWeber","download_url":"https://codeload.github.com/AndresMWeber/nomenclate-api-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndresMWeber%2Fnomenclate-api-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271591353,"owners_count":24786411,"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","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-10-11T22:29:27.758Z","updated_at":"2025-08-22T05:35:50.878Z","avatar_url":"https://github.com/AndresMWeber.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=200px height=200px src=\"/docs/nomenclate_logo.png\" alt=\"nomenclate logo\"\u003e\n\u003c/p\u003e\n\n\u003ch2 align=\"center\"\u003eNomenclate API\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/AndresMWeber/nomenclate-api-python\"\u003e\n        \u003cimg alt=\"Status\" src=\"https://img.shields.io/badge/status-active-success.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/AndresMWeber/nomenclate-api-python/issues\"\u003e\n        \u003cimg alt=\"Issues\" src=\"https://img.shields.io/github/issues/andresmweber/nomenclate-api-python.svg\" /\u003e\n    \u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/AndresMWeber/nomenclate-api-python/actions/workflows/readme-api-sync.yml\"\u003e\n        \u003cimg alt=\"Documentation CD\" src=\"https://github.com/AndresMWeber/nomenclate-api-python/actions/workflows/readme-api-sync.yml/badge.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/AndresMWeber/nomenclate-api-python/actions/workflows/python-app.yml\"\u003e\n        \u003cimg alt=\"CI\" src=\"https://github.com/AndresMWeber/nomenclate-api-python/actions/workflows/python-app.yml/badge.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/AndresMWeber/nomenclate-api-python/actions/workflows/deploy-serverless.yml\"\u003e\n        \u003cimg alt=\"CD\" src=\"https://github.com/AndresMWeber/nomenclate-api-python/actions/workflows/deploy-serverless.yml/badge.svg\" /\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/AndresMWeber/nomenclate-api-python/blob/master/LICENSE\"\u003e\n        \u003cimg alt=\"License\" src=\"https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\".\"\u003e\n        \u003cimg alt=\"GitHub code size in bytes\" src=\"https://img.shields.io/github/languages/code-size/andresmweber/nomenclate-api-python\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/AndresMWeber/nomenclate-api-python\"\u003e\n        \u003cimg alt=\"CodeCoverage\" src=\"https://codecov.io/gh/AndresMWeber/nomenclate-api-python/branch/main/graph/badge.svg?token=4EC7Z5IKKB\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://nomenclate.readme.io/\"\u003e\n        \u003cimg alt=\"readme\" src=\"https://img.shields.io/badge/read-me-blue\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\nAn API using the Nomenclate package to automate and generate strings based on arbitrary user-defined naming conventions.\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\u003ch3 align=\"center\"\u003e\n    \u003ccode\u003e\n    \u003ca href=\"https://nom-api.andresmweber.com/\"\u003e\u003cimg width=14px alt=\"Github Favicon\" src=\"https://aws.amazon.com/favicon.ico\" /\u003e Live Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\n    \u003c/code\u003e\n\u003c/h3\u003e\n\n## 📝 Table of Contents\n\n- [Installation](#installation)\n    - [Prerequsites](#prerequsites)\n    - [Install steps](#install-steps)\n  - [🚀 Deployment \u003ca name = \"deployment\"\u003e\u003c/a\u003e](#-deployment-)\n    - [Modifications to `serverless.yml`](#modifications-to-serverlessyml)\n    - [Deploying to AWS](#deploying-to-aws)\n  - [⛏️ Tech Stack \u003ca name = \"tech\"\u003e\u003c/a\u003e](#️-tech-stack-)\n  - [✍️ Authors \u003ca name = \"authors\"\u003e\u003c/a\u003e](#️-authors-)\n\n# Installation\n\n### Prerequsites\n\n1. [Python](https://www.python.org/) and [Python Poetry](https://python-poetry.org/) is installed\n2. [NodeJS](https://www.nodejs.org/) is installed\n3. You have a [Serverless](https://www.serverless.com/) account\n4. You have an [AWS](https://aws.amazon.com/) account\n5. You have started a [MongoDB Atlas](https://www.mongodb.com/) cluster.\n\n### Install steps\n1. `npm install`  \n2. `poetry install` (To install in the top level directory always: `poetry config virtualenvs.in-project true`)\n3. You should now have access to the serverless CLI (if you haven't, you need to login using `sls login`)\n4. Now feel free to [invoke the lambdas](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke-local/) using `sls invoke local --function \u003cfunction name\u003e`\n\n## 🚀 Deployment \u003ca name = \"deployment\"\u003e\u003c/a\u003e\n\n### Modifications to `serverless.yml`\n1. The default is an `AWS profile` named '**aw**'.  If you have a different profile in your [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) you need to change the name in the provider.profile section.\n2. If you do not require/have a [custom domain name or certificate](https://www.serverless.com/blog/serverless-api-gateway-domain), remove the `customDomain` section.\n\n### Deploying to AWS\n\nThis project is deployed on AWS using Serverless to automate the deployment.\n\nOnce the modifications are put in to `serverless.yml` you can use the [Serverless CLI](https://www.serverless.com/framework/docs/providers/aws/cli-reference/) to deploy.\n\nThere are also ease of use Poetry commands in place:\n- `poetry run poe deploy-domain` - To deploy the custom domain (necessary before deploying if you set it up in the modifications)\n- `poetry run poe deploy` - To deploy the stack to AWS\n\n\n## ⛏️ Tech Stack \u003ca name = \"tech\"\u003e\u003c/a\u003e\n\n- [NodeJS](https://www.nodejs.org/) - Web Server\n- [Python](https://www.python.org/) - Front End\n- [AWS](https://aws.amazon.com/) - Hosting\n- [Serverless](https://www.serverless.com/) - CD\n- [MongoDB](https://www.mongodb.com/) - Database\n\n## ✍️ Authors \u003ca name = \"authors\"\u003e\u003c/a\u003e\n\n\u003ca href=\"https://github.com/andresmweber/\"\u003e\n    \u003cimg title=\"Andres Weber\" src=\"https://github.com/andresmweber.png\" height=\"50px\"\u003e\n\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandresmweber%2Fnomenclate-api-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandresmweber%2Fnomenclate-api-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandresmweber%2Fnomenclate-api-python/lists"}