Première version - squelette

This commit is contained in:
François Pelletier 2023-09-24 12:58:19 -04:00
parent 696b5a3d8c
commit 43653afd08
8 changed files with 297 additions and 90 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
/.idea/
/permissions.db

View file

@ -1,92 +1,2 @@
# Registre Permissions
## 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/partage/registre-permissions.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://git.jevalide.ca/partage/registre-permissions/-/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.

99
crud.py Normal file
View file

@ -0,0 +1,99 @@
def add_person():
# TODO: add
return 0
def list_person():
# TODO: list
return 0
def edit_person():
# TODO: edit
return 0
def delete_person():
# TODO: delete
return 0
def add_resource():
# TODO: add
return 0
def list_resource():
# TODO: list
return 0
def edit_resource():
# TODO: edit
return 0
def delete_resource():
# TODO: delete
return 0
def add_role():
# TODO: add
return 0
def list_role():
# TODO: list
return 0
def edit_role():
# TODO: edit
return 0
def delete_role():
# TODO: delete
return 0
def add_permission():
# TODO: add
return 0
def list_permission():
# TODO: list
return 0
def edit_permission():
# TODO: edit
return 0
def delete_permission():
# TODO: delete
return 0
def add_user_account():
# TODO: add
return 0
def list_user_account():
# TODO: list
return 0
def edit_user_account():
# TODO: edit
return 0
def delete_user_account():
# TODO: delete
return 0

File diff suppressed because one or more lines are too long

54
data_models.py Normal file
View file

@ -0,0 +1,54 @@
from peewee import *
from playhouse.sqlcipher_ext import SqlCipherDatabase
db = SqlCipherDatabase(None)
class Person(Model):
id = AutoField()
first_name = CharField()
last_name = CharField()
date = DateField()
class Meta:
database = db
class Resource(Model):
id = AutoField()
name = CharField()
class Meta:
database = db
class Role(Model):
id = AutoField()
name = CharField()
description = CharField()
class Meta:
database = db
class Permission(Model):
id = AutoField()
name = CharField()
idResource = ForeignKeyField(Resource, related_name='has_permission')
idRole = ForeignKeyField(Role, related_name='has_permission')
description = CharField()
class Meta:
database = db
class UserAccount(Model):
id = AutoField()
username = CharField()
idPerson = ForeignKeyField(Person, related_name='has_user_account')
idResource = ForeignKeyField(Resource, related_name='has_user_account')
idRole = ForeignKeyField(Role, related_name='has_user_account')
date = DateField()
class Meta:
database = db

138
main.py Normal file
View file

@ -0,0 +1,138 @@
#!/usr/bin/env python
# A large proportion of this code is taken from the peewee project.
# This code is made available under the MIT License
# https://github.com/coleifer/peewee/tree/master
from collections import OrderedDict
from getpass import getpass
import sys
import data_models as dm
from crud import *
def initialize(db_passphrase):
dm.db.init("permissions.db", passphrase=db_passphrase)
list_table_models = [dm.Person,
dm.Resource,
dm.Role,
dm.Permission,
dm.UserAccount]
dm.db.create_tables(list_table_models)
def menu_loop():
menu_choice = None
while menu_choice != 'q':
for key, value in menu.items():
print('%s) %s' % (key, value[1]))
menu_choice = input('Action: ').lower().strip()
if menu_choice in menu:
menu[menu_choice][0]()
def person_menu_loop():
person_menu_choice = None
while person_menu_choice != 'q':
for key, value in person_menu.items():
print('%s) %s' % (key, value[1]))
person_menu_choice = input('Action: ').lower().strip()
if person_menu_choice in person_menu:
person_menu[person_menu_choice][0]()
def resource_menu_loop():
resource_menu_choice = None
while resource_menu_choice != 'q':
for key, value in resource_menu.items():
print('%s) %s' % (key, value[1]))
resource_menu_choice = input('Action: ').lower().strip()
if resource_menu_choice in resource_menu:
resource_menu[resource_menu_choice][0]()
def role_menu_loop():
role_menu_choice = None
while role_menu_choice != 'q':
for key, value in role_menu.items():
print('%s) %s' % (key, value[1]))
role_menu_choice = input('Action: ').lower().strip()
if role_menu_choice in role_menu:
role_menu[role_menu_choice][0]()
def permission_menu_loop():
permission_menu_choice = None
while permission_menu_choice != 'q':
for key, value in permission_menu.items():
print('%s) %s' % (key, value[1]))
permission_menu_choice = input('Action: ').lower().strip()
if permission_menu_choice in permission_menu:
permission_menu[permission_menu_choice][0]()
def user_account_menu_loop():
user_account_menu_choice = None
while user_account_menu_choice != 'q':
for key, value in user_account_menu.items():
print('%s) %s' % (key, value[1]))
user_account_menu_choice = input('Action: ').lower().strip()
if user_account_menu_choice in user_account_menu:
user_account_menu[user_account_menu_choice][0]()
menu = OrderedDict([
('1', (person_menu_loop, "Person")),
('2', (resource_menu_loop, "Resource")),
('3', (role_menu_loop, "Role")),
('4', (permission_menu_loop, "Permission")),
('5', (user_account_menu_loop, "User Account"))
])
person_menu = OrderedDict([
('1', (add_person, "Add Person")),
('2', (list_person, "List Person")),
('3', (edit_person, "Edit Person")),
('4', (delete_person, "Delete Person")),
])
resource_menu = OrderedDict([
('1', (add_resource, "Add Resource")),
('2', (list_resource, "List Resources")),
('3', (edit_resource, "Edit Resource")),
('4', (delete_resource, "Delete Resource")),
])
role_menu = OrderedDict([
('1', (add_role, "Add Role")),
('2', (list_role, "List Roles")),
('3', (edit_role, "Edit Role")),
('4', (delete_role, "Delete Role")),
])
permission_menu = OrderedDict([
('1', (add_permission, "Add Permission")),
('2', (list_permission, "List Permissions")),
('3', (edit_permission, "Edit Permission")),
('4', (delete_permission, "Delete Permission")),
])
user_account_menu = OrderedDict([
('1', (add_user_account, "Add User Account")),
('2', (list_user_account, "List User Accounts")),
('3', (edit_user_account, "Edit User Account")),
('4', (delete_user_account, "Delete User Account")),
])
if __name__ == '__main__':
# Collect the passphrase using a secure method.
passphrase = getpass('Entre le mot de passe: ')
if not passphrase:
sys.stderr.write('Un mot de passe est requis pour accéder à la base de données.\n')
sys.stderr.flush()
sys.exit(1)
# Initialize the database.
initialize(passphrase)
menu_loop()

2
requirements.txt Normal file
View file

@ -0,0 +1,2 @@
sqlcipher3_binary~=0.5.2
peewee~=3.16.3

1
run_app.sh Normal file
View file

@ -0,0 +1 @@
python main.py