Skip to content

Commit 3564024

Browse files
committed
Rename flog to flemi
1 parent 81f370a commit 3564024

35 files changed

+46
-48
lines changed

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ repos:
1111
hooks:
1212
- id: reorder-python-imports
1313
args: ["--application-directories", "src"]
14-
files: flog
14+
files: flemi
1515
- repo: https://github.com/psf/black
1616
rev: 22.3.0
1717
hooks:
1818
- id: black
19-
files: flog
19+
files: flemi
2020
- repo: https://github.com/PyCQA/flake8
2121
rev: 4.0.1
2222
hooks:
2323
- id: flake8
24-
files: flog
24+
files: flemi
2525
- repo: https://github.com/pre-commit/pre-commit-hooks
2626
rev: v4.2.0
2727
hooks:

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
# Flog API v4
1+
# Flemi API
22

33
> **Tips:** This repository is still under construction.
44
5-
This project is actually a side project of z-t-y/Flog, working as Flog's new web API.
6-
There's currently 3 API versions in Flog repository, and, because of this, this project
7-
is version 4.
5+
This project is the new version of z-t-y/Flog.
86

9-
API v4 is written to be the back-end of this website project, there's also a front-end
10-
project of Flog (using React.js).
7+
This written is written to be the back-end of this website project, there's also a front-end
8+
project of Flemi (using React.js).
119

1210
## How to install
1311

14-
Flog API v4 uses [PDM](https://github.com/pdm-project/pdm) to manage its dependencies,
12+
Flemi API uses [PDM](https://github.com/pdm-project/pdm) to manage its dependencies,
1513
so you should install PDM first:
1614

1715
```powershell
@@ -25,7 +23,7 @@ then install with PDM:
2523
pdm install
2624
```
2725

28-
To initialize Flog API, you must make the database and administrator ready with command:
26+
To initialize Flemi API, you must make the database and administrator ready with command:
2927

3028
```powershell
3129
flask deploy
@@ -35,9 +33,9 @@ flask create-admin
3533
If you want to generate fake data for testing, you should use command `flask forge` after
3634
running the command above.
3735

38-
Then you can run our Flog API. In most cases just use `flask run`, but if you use servers
36+
Then you can run our Flemi API. In most cases just use `flask run`, but if you use servers
3937
like PythonAnywhere, Heroku, etc. Read its docs and go on.
4038

4139
## Credits
4240

43-
Flog project is created by [@z-t-y](https://github.com/z-t-y). Now maintained by [helloflask/floggers](https://github.com/orgs/helloflask/teams/floggers). See contributors for more information.
41+
Flemi project is created by [@z-t-y](https://github.com/z-t-y). Now maintained by [helloflask/floggers](https://github.com/orgs/helloflask/teams/floggers). See contributors for more information.

flog/__init__.py renamed to flemi/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
def create_app(config_name=None) -> Flask:
2323
if config_name is None:
2424
config_name = os.getenv("FLASK_CONFIG", "development")
25-
app = APIFlask("flog")
25+
app = APIFlask("flemi")
2626
app.wsgi_app = ProxyFix(app.wsgi_app, x_host=1)
2727

2828
@app.get("/")
2929
def index():
3030
"""
3131
help API of the app
3232
"""
33-
return {"/": "version 4.x of flog web API"}
33+
return {"/": "version 4.x of flemi web API"}
3434

3535
register_config(app, config_name)
3636
register_blueprints(app)
@@ -52,7 +52,7 @@ def register_extensions(app: Flask) -> None:
5252

5353
def register_blueprints(app: Flask) -> None:
5454
for mod_name in ("auth", "me", "post", "user"):
55-
mod = il.import_module(f".api_v4.{mod_name}.views", "flog")
55+
mod = il.import_module(f".api.{mod_name}.views", "flemi")
5656
blueprint = getattr(mod, f"{mod_name}_bp")
5757
CORS(blueprint)
5858
app.register_blueprint(blueprint)

0 commit comments

Comments
 (0)