Version initiale fonctionnelle

This commit is contained in:
François Pelletier 2023-09-14 11:21:42 -04:00
parent 7e3901c667
commit d99cb78149
12 changed files with 284 additions and 92 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
/.idea/

38
.gitlab-ci.yml Normal file
View file

@ -0,0 +1,38 @@
# .gitlab-ci.yml
stages:
- dockerize
- deployment
build-push-docker-image-job:
stage: dockerize
# Specify a Docker image to run the job in.
image: docker:20-dind
# Specify an additional image 'docker:dind' ("Docker-in-Docker") that
# will start up the Docker daemon when it is brought up by a runner.
before_script:
- docker login -u "$DOCKER_REGISTRY_USER" -p "$DOCKER_REGISTRY_PASSWORD" $DOCKER_REGISTRY_URL # Instructs GitLab to login to its registry
services:
- name: docker:20-dind
alias: docker
command: ["--tls=false"]
script:
- echo "Building..." # MAKE SURE NO SPACE ON EITHER SIDE OF = IN THE FOLLOWING LINE
- export CONTAINER_FULL_IMAGE_NAME_WITH_TAG=$IMAGE_NAME_WITH_REGISTRY_PREFIX/my-build-image:$COMMIT_HASH
- docker build -f ./Dockerfile --pull -t built-image-name .
- docker tag built-image-name "$CONTAINER_FULL_IMAGE_NAME_WITH_TAG"
- docker push "$CONTAINER_FULL_IMAGE_NAME_WITH_TAG"
- echo "$CONTAINER_FULL_IMAGE_NAME_WITH_TAG"
- echo "Deploying on CapRover..."
- docker run caprover/cli-caprover:2.3.0 caprover deploy --caproverUrl "$CAPROVER_URL" --caproverPassword "$CAPROVER_PASSWORD" -a "$CAPROVER_APP" -i "$CONTAINER_FULL_IMAGE_NAME_WITH_TAG"
only:
- main
variables:
DOCKER_REGISTRY_USER: ${CI_REGISTRY_USER}
DOCKER_REGISTRY_PASSWORD: ${CI_REGISTRY_PASSWORD}
DOCKER_REGISTRY_URL: ${CI_REGISTRY}
IMAGE_NAME_WITH_REGISTRY_PREFIX: ${CI_REGISTRY_IMAGE}
COMMIT_HASH: ${CI_COMMIT_SHA}
CAPROVER_URL: ${CAPROVER_URL}
CAPROVER_PASSWORD: ${CAPROVER_PASSWORD}
CAPROVER_APP: ${CAPROVER_APP}

17
Dockerfile Normal file
View file

@ -0,0 +1,17 @@
FROM python:3.11-slim
# Expose the application port
EXPOSE 8000
# Set the application working directory
WORKDIR /app
# Install the app's dependencies
RUN pip install --upgrade pip
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY *.py ./
# Run the application
CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

View file

@ -1,92 +1 @@
# point-median-backend
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://git.jevalide.ca/jevalideca/point-median-backend.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://git.jevalide.ca/jevalideca/point-median-backend/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
# point-median-backend

1
build-local.sh Normal file
View file

@ -0,0 +1 @@
docker build -t local/point-median-backend .

43
convertir_point_median.py Normal file
View file

@ -0,0 +1,43 @@
import re
sep = r"[.\-/]"
def convertir_point_median(texte):
versions = [texte]
# Règles à 3 composantes
regles3 = [fr"(\w+){sep}(\w+[es]*){sep}([es]+)",
fr"([td]eur){sep}([td]rice){sep}([s]+)",
fr"(eur){sep}(ice|euse){sep}([s]+)",
fr"(er){sep}(ère){sep}([s]+)",
fr"([fs]){sep}([fs]{2}e){sep}([s]+)",
fr"([eo][lnt]){sep}([eo]?[lnt]+e){sep}([s]+)"]
for r in regles3:
versions.append(re.sub(r, r"\\\3", versions[-1]))
# Règles à 2 composantes
regles2 = [fr"(\w+){sep}([es]+)",
fr"([td]eur[s]?){sep}([td]?rice[s]?)",
fr"(eur[s]?){sep}(euse[s]?|ice[s]?)",
fr"(eux|el){sep}(elle[s]?|euse[s]?|le[s]?)",
fr"(aux|al){sep}(ale[s]?)",
fr"(er[s]?){sep}(ère[s]?)",
fr"([s]){sep}([s]{2}e[s]?)",
fr"([eo][flnt][s]?){sep}([eo]?[flnt]+e[s]?)",
fr"(\w+e){sep}(\w+a)",
fr"(\w+t){sep}(te)"]
for r in regles2:
versions.append(re.sub(r, r"\\2", versions[-1]))
# Règles avec des parenthèses
reglesp = [r"(\w+)[\(]([es]+)[\)]",
r"([td]eur[s]?)[\(]([td]?rice[s]?)[\)]",
r"(eur[s]?)[\(](euse[s]?|ice[s]?)[\)]",
r"(eux|el)[\(](elle[s]?|euse[s]?|le[s]?)[\)]",
r"(aux|al)[\(](ale[s]?)[\)]",
r"(er[s]?)[\(](ère[s]?)[\)]",
r"([s])[\(]([s]{2}e[s]?)[\)]",
r"([eo][flnt][s]?)[\(]([eo]?[flnt]+e[s]?)[\)]",
r"(\w+e)[\(](\w+a)[\)]",
r"(\w+t)[\(](te)[\)]"]
for r in reglesp:
versions.append(re.sub(r, r"\\2", versions[-1]))
return versions[-1]

22
main.py Normal file
View file

@ -0,0 +1,22 @@
from fastapi import FastAPI
from pydantic import BaseModel
import convertir_point_median as cpm
app = FastAPI()
class TranslationRequest(BaseModel):
text: str
class TranslationResponse(BaseModel):
text: str
@app.get("/corriger")
def translate(request: TranslationRequest):
# Implement Point-Median algorithm here
texte = request.text
texte_corrige = cpm.convertir_point_median(texte)
response = TranslationResponse(text=texte_corrige)
return response

3
requirements.txt Normal file
View file

@ -0,0 +1,3 @@
fastapi~=0.103.1
pydantic~=2.3.0
uvicorn~=0.23.2

4
run-local.sh Normal file
View file

@ -0,0 +1,4 @@
docker stop point-median-backend
docker rm point-median-backend
# Ce programme sert à lancer le job_dispatcher dans un docker localement pour tester
docker run -p 8000:8000 --name point-median-backend --network host local/point-median-backend

1
run-tests.sh Normal file
View file

@ -0,0 +1 @@
pytest test.py

147
test.py Normal file
View file

@ -0,0 +1,147 @@
import convertir_point_median as cpm
def test_answer():
# point
assert cpm.convertir_point_median("invité.e") == "invité·e"
assert cpm.convertir_point_median("invité.es") == "invité·es"
assert cpm.convertir_point_median("candidat.e") == "candidat·e"
assert cpm.convertir_point_median(
"Conseiller.ère") == "Conseiller·ère"
assert cpm.convertir_point_median(
"Conseillers.ères") == "Conseillers·ères"
assert cpm.convertir_point_median(
"directeur.trice") == "directeur·trice"
assert cpm.convertir_point_median(
"directeur.rice") == "directeur·rice"
assert cpm.convertir_point_median(
"directeur.trices") == "directeur·trices"
assert cpm.convertir_point_median(
"directeurs.trices") == "directeurs·trices"
assert cpm.convertir_point_median("soudeur.euse") == "soudeur·euse"
assert cpm.convertir_point_median("soudeur.euses") == "soudeur·euses"
assert cpm.convertir_point_median(
"soudeurs.euses") == "soudeurs·euses"
assert cpm.convertir_point_median("tou.te.s") == "tou·te·s"
assert cpm.convertir_point_median("le.la") == "le·la"
assert cpm.convertir_point_median(
"nouvel.le employé.e") == "nouvel·le employé·e"
assert cpm.convertir_point_median("égaux.ales") == "égaux·ales"
assert cpm.convertir_point_median("acteur.ice.s") == "acteur·ice·s"
assert cpm.convertir_point_median("cet.te") == "cet·te"
assert cpm.convertir_point_median("praticien.nes") == "praticien·nes"
assert cpm.convertir_point_median("hôte.sse") == "hôte·sse"
assert cpm.convertir_point_median("chef.fe") == "chef·fe"
assert cpm.convertir_point_median("praticien.ne.s") == "praticien·ne·s"
assert cpm.convertir_point_median("hôte.sses") == "hôte·sses"
assert cpm.convertir_point_median("chef.fe.s") == "chef·fe·s"
assert cpm.convertir_point_median("ambassadeur.drice") == "ambassadeur·drice"
# barre oblique
assert cpm.convertir_point_median("invité/e") == "invité·e"
assert cpm.convertir_point_median("invité/es") == "invité·es"
assert cpm.convertir_point_median("candidat/e") == "candidat·e"
assert cpm.convertir_point_median(
"Conseiller/ère") == "Conseiller·ère"
assert cpm.convertir_point_median(
"Conseillers/ères") == "Conseillers·ères"
assert cpm.convertir_point_median(
"directeur/trice") == "directeur·trice"
assert cpm.convertir_point_median(
"directeur/rice") == "directeur·rice"
assert cpm.convertir_point_median(
"directeur/trices") == "directeur·trices"
assert cpm.convertir_point_median(
"directeurs/trices") == "directeurs·trices"
assert cpm.convertir_point_median("soudeur/euse") == "soudeur·euse"
assert cpm.convertir_point_median("soudeur/euses") == "soudeur·euses"
assert cpm.convertir_point_median(
"soudeurs/euses") == "soudeurs·euses"
assert cpm.convertir_point_median("tou/te/s") == "tou·te·s"
assert cpm.convertir_point_median("le/la") == "le·la"
assert cpm.convertir_point_median(
"nouvel/le employé/e") == "nouvel·le employé·e"
assert cpm.convertir_point_median("égaux/ales") == "égaux·ales"
assert cpm.convertir_point_median("acteur/ice/s") == "acteur·ice·s"
assert cpm.convertir_point_median("cet/te") == "cet·te"
assert cpm.convertir_point_median("praticien/nes") == "praticien·nes"
assert cpm.convertir_point_median("hôte/sse") == "hôte·sse"
assert cpm.convertir_point_median("chef/fe") == "chef·fe"
assert cpm.convertir_point_median("praticien/ne/s") == "praticien·ne·s"
assert cpm.convertir_point_median("hôte/sses") == "hôte·sses"
assert cpm.convertir_point_median("chef/fe/s") == "chef·fe·s"
assert cpm.convertir_point_median("ambassadeur/drice") == "ambassadeur·drice"
# tiret
assert cpm.convertir_point_median("invité-e") == "invité·e"
assert cpm.convertir_point_median("invité-es") == "invité·es"
assert cpm.convertir_point_median("candidat-e") == "candidat·e"
assert cpm.convertir_point_median(
"Conseiller-ère") == "Conseiller·ère"
assert cpm.convertir_point_median(
"Conseillers-ères") == "Conseillers·ères"
assert cpm.convertir_point_median(
"directeur-trice") == "directeur·trice"
assert cpm.convertir_point_median(
"directeur-rice") == "directeur·rice"
assert cpm.convertir_point_median(
"directeur-trices") == "directeur·trices"
assert cpm.convertir_point_median(
"directeurs-trices") == "directeurs·trices"
assert cpm.convertir_point_median("soudeur-euse") == "soudeur·euse"
assert cpm.convertir_point_median("soudeur-euses") == "soudeur·euses"
assert cpm.convertir_point_median(
"soudeurs-euses") == "soudeurs·euses"
assert cpm.convertir_point_median("tou-te-s") == "tou·te·s"
assert cpm.convertir_point_median("le-la") == "le·la"
assert cpm.convertir_point_median(
"nouvel-le employé-e") == "nouvel·le employé·e"
assert cpm.convertir_point_median("égaux-ales") == "égaux·ales"
assert cpm.convertir_point_median("acteur-ice-s") == "acteur·ice·s"
assert cpm.convertir_point_median(
"Hey salut mon ami-e. Bonjour à toi.") == "Hey salut mon ami·e. Bonjour à toi."
assert cpm.convertir_point_median("cet-te") == "cet·te"
assert cpm.convertir_point_median("praticien-nes") == "praticien·nes"
assert cpm.convertir_point_median("hôte-sse") == "hôte·sse"
assert cpm.convertir_point_median("chef-fe") == "chef·fe"
assert cpm.convertir_point_median("praticien-ne-s") == "praticien·ne·s"
assert cpm.convertir_point_median("hôte-sses") == "hôte·sses"
assert cpm.convertir_point_median("chef-fe-s") == "chef·fe·s"
assert cpm.convertir_point_median("ambassadeur-drice") == "ambassadeur·drice"
# parenthèses (pas de symbole dans la parenthèse)
assert cpm.convertir_point_median("invité(e)") == "invité·e"
assert cpm.convertir_point_median("invité(es)") == "invité·es"
assert cpm.convertir_point_median("candidat(e)") == "candidat·e"
assert cpm.convertir_point_median(
"Conseiller(ère)") == "Conseiller·ère"
assert cpm.convertir_point_median(
"Conseillers(ères)") == "Conseillers·ères"
assert cpm.convertir_point_median(
"directeur(trice)") == "directeur·trice"
assert cpm.convertir_point_median(
"directeur(rice)") == "directeur·rice"
assert cpm.convertir_point_median(
"directeur(trices)") == "directeur·trices"
assert cpm.convertir_point_median(
"directeurs(trices)") == "directeurs·trices"
assert cpm.convertir_point_median("soudeur(euse)") == "soudeur·euse"
assert cpm.convertir_point_median("soudeur(euses)") == "soudeur·euses"
assert cpm.convertir_point_median(
"soudeurs(euses)") == "soudeurs·euses"
assert cpm.convertir_point_median("le(la)") == "le·la"
assert cpm.convertir_point_median(
"nouvel(le) employé(e)") == "nouvel·le employé·e"
assert cpm.convertir_point_median("égaux(ales)") == "égaux·ales"
assert cpm.convertir_point_median(
"Hey salut mon ami(e). Bonjour à toi.") == "Hey salut mon ami·e. Bonjour à toi."
assert cpm.convertir_point_median("cet(te)") == "cet·te"
assert cpm.convertir_point_median("praticien(nes)") == "praticien·nes"
assert cpm.convertir_point_median("hôte(sse)") == "hôte·sse"
assert cpm.convertir_point_median("chef(fe)") == "chef·fe"
assert cpm.convertir_point_median("hôte(sses)") == "hôte·sses"
assert cpm.convertir_point_median("ambassadeur(drice)") == "ambassadeur·drice"

6
tests.http Normal file
View file

@ -0,0 +1,6 @@
GET localhost:8000/corriger
Content-Type: application/json
{
"text": "ami.e"
}