删除历史版本, 初始化仓库

2022-06-02 18:50:09 +08:00
commit 91c9c2ba7c
@@ -0,0 +1,16 @@
+# Dirs
+.idea/
+build/
+dist/
+
+
+# Files
+*.pyc
+*.zip
+*.tar
+*.gz
+*.sqlite
+*.log
+*.log.*
+*.sql
+*.gif
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2022] [MarkusJoe]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
@@ -0,0 +1 @@
+web: gunicorn manage:app
@@ -0,0 +1,67 @@
+<p align="center">
+    <a href="https://github.com/MarkusJoe/FlaskRequestCounter">
+        <img src="https://img.shields.io/badge/Python-3.10.x-blue.svg" alt="PythonVersion">
+        <img src="https://img.shields.io/badge/LINCESE-Apache2.0-orange.svg" alt="LICENSE">
+        <img src="https://img.shields.io/badge/Falsk-2.0.3-purple" alt="FlaskVersion">
+    </a>
+</p>
+
+<div align="center">
+    <img src="https://requestcounters.herokuapp.com/get?name=MarkusJoe" alt="Counter">
+</div>
+
+* 上方的计数器为不更新版本只保留了最基本的功能
+
+## Python 版访问次数计数器 使用了flask 作为服务端接收请求
+
+* [文档](https://request-counter-docs.vercel.app/#/)
+
+### 开源
+
+- 本项目以[Apache-2.0](./LICENSE)许可开源, 即:
+    - 你可以直接使用该项目提供的功能, 无需任何授权
+    - 你可以在**注明来源版权信息**的情况下对源代码进行任意分发和修改以及衍生
+
+## 部署
+
+> 在部署之前你需要先安装`python3.10.x`以上的版本
+
+### 已部署好的地址
+
+* [Click to enter](https://requestcounter.herokuapp.com/count/MarkusJoe)
+* 默认主题: `lewd`
+
+### 部署到Heroku
+
+1. `fork` 本项目到你的仓库
+2. 在[Heroku](https://www.heroku.com/) 注册账号
+3. 在[Dashboard](https://dashboard.heroku.com/apps) 新建App
+4. 流程: 进入网址 -> 点击右上角`New` -> 点击 `Create new app` -> 输入App名称 -> `Create app` -> 选择`Github` (登陆完成后) -> 点击`Search` ->
+   选择你fork的项目并点击`Connect` -> 滑到末尾点击`Deploy branch`(如果你想在仓库更新时自动部署的话可以把`Enable Automatic Deploy`勾选) -> 等待完成
+5. App的地址就是 `App名称` + `.herokuapp.com`
+
+### 部署到本地服务器
+
+```shell
+$ git clone https://github.com/MarkusJoe/RequestCounter.git
+$ cd RequestCounter
+$ pip3 install -r requirements.txt
+```
+
+### 启动服务
+
+```shell
+$ python3 manage.py or gunicorn manage:app or waitress-serve --port=5000 manage:app
+```
+
+## 调用须知
+
+- API支持`GET` 和 `POST` 方法请求
+- 最大可以计数`10`位数, 超过则重置
+- 可以自定义显示位数默认`7`位数最大`10`位
+- 可以自己选择更多的主题只需要加上请求参数: `theme` 再加上想要的主题即可
+
+# 一些信息
+
+- 使用了Python3.6 的标准库`Sqlite3`进行数据库操作
+- 你可以在`api`获取原始数据, 文档地址: [文档](https://markusjoe.github.io/RequestCounter/#/?id=api)
@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: __init__.py
+
+
+import os
+from flask import Flask
+from flask_sslify import SSLify
+from .main import main as main_blueprint
+from .api import api as api_blueprint
+from .config import config
+from .utils.password import generate_pwd
+
+
+def create_app(config_name):
+    """
+    创建 app
+    :param config_name:
+    :return:
+    """
+    app = Flask(__name__)
+    app.config.from_object(config[config_name])
+    config[config_name].init_app(app)
+    if app.config['SSL_REDIRECT']:
+        SSLify(app)
+
+    app.register_blueprint(main_blueprint)
+    app.register_blueprint(api_blueprint, url_prefix='/api/v1/')
+
+    access_key = os.getenv('ACCESS_KEY')
+    secret = app.config['SECRET_KEY']
+    try:
+        if not access_key and not secret:
+            access_key = generate_pwd(16)
+        elif not access_key and secret:
+            access_key = secret
+    finally:
+        os.environ['ACCESS_KEY'] = access_key
+
+    app.logger.info('访问密钥: {}'.format(access_key))
+
+    return app
+
+
+__all__ = [
+    'db',
+    'main',
+    'tests',
+    'utils',
+    'create_app'
+]
@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/4/9
+# @File Name: __init__.py.py
+
+
+from flask import Blueprint
+
+api = Blueprint('api', __name__)
+
+from . import views, errors
+
+__all__ = [
+    'api',
+    'views',
+    'errors'
+]
@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/5/2
+# @File Name: auth.py
+
+
+import os
+from flask import request
+from flask_httpauth import HTTPTokenAuth
+
+auth = HTTPTokenAuth()
+
+
+@auth.verify_token
+def verify_token(token):
+    secret_key = os.getenv('ACCESS_KEY')
+    key = request.args.get('key')
+    if token or key == secret_key:
+        return True
+    elif (token == 'unittest' or
+          key == 'unittest') and \
+            'system' in request.path.split('/'):  # 限定在system这个接口使用unittest密钥获取数据
+        return True
+    return False
@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/4/9
+# @File Name: errors.py
+
+from . import api
+from .auth import auth
+from flask import jsonify
+
+
+@api.errorhandler(403)
+@auth.error_handler
+def forbidden(e):
+    return jsonify(
+        {
+            'code': 403,
+            'msg': 'API: Permission Denied.',
+            'data': None
+        }
+    ), 403
+
+
+@api.errorhandler(404)
+def page_not_found(e):
+    return jsonify(
+        {
+            'code': 404,
+            'msg': 'API: Page Not Found.',
+            'data': None
+        }
+    ), 404
+
+
+@api.errorhandler(500)
+def internal_server_error(e):
+    return jsonify(
+        {
+            'code': 500,
+            'msg': 'API: Internal Server Error.',
+            'data': None
+        }
+    ), 500
@@ -0,0 +1,172 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/4/9
+# @File Name: views.py
+
+
+import sys
+import psutil
+import platform
+from flask import jsonify
+from flask import request
+from flask import send_file
+from ..db.db import SQLite as db
+from . import api
+from .auth import auth
+
+
+@api.route('/test/', methods=['GET', 'POST'])
+def test_api():
+    """
+    测试专用接口
+    :return:
+    """
+    data = db().fetch('test-example')
+    return str(data[1])
+
+
+@api.route('/overall/', methods=['GET', 'POST'])
+def overall():
+    """
+    查询ReqCount表内所有的源数据
+    :return:
+    """
+    limit = request.args.get('limit', type=int)
+    try:
+        data = db().exec('select * from reqcount;')
+        format_data = []
+        for i in data:
+            format_data.append({'name': i[0], 'times': i[1]})
+        return jsonify(
+            {
+                'code': 200,
+                'msg': 'Success. Total: %s row(s)' % len(data),
+                'data': format_data[:limit]
+            }
+        ), 200
+    except Exception as e:
+        return jsonify(
+            {
+                'code': -200,
+                'msg': 'Error',
+                'data': e
+            }
+        ), 500
+
+
+@api.route('/query/', methods=['GET', 'POST'])
+def query():
+    """
+    查询指定名称的计数数据
+    :return:
+    """
+    name = request.args.get('name', type=str)
+    nochange = request.args.get('nochange', type=bool)
+    if nochange:
+        nochange = True
+    if not db().exists_name(name):
+        return jsonify(
+            {
+                'code': -200,
+                'msg': 'Failed. No such name',
+                'data': None
+            }
+        ), 404
+    else:
+        data = db().fetch(name, nochange)
+        return jsonify(
+            {
+                'code': 200,
+                'msg': 'Success',
+                'data': data
+            }
+        ), 200
+
+
+@api.route('/theme/', methods=['GET', 'POST'])
+def theme():
+    """
+    查询数据库内主题的源数据
+    :return:
+    """
+    _theme = request.args.get('name', type=str)
+    if not db().exists_table(_theme):
+        return jsonify(
+            {
+                'code': 404,
+                'msg': 'Failed. No such theme',
+                'data': None
+            }
+        ), 404
+    else:
+        data = db().fetching_table(_theme)
+        return jsonify(
+            {
+                'code': 200,
+                'msg': 'Success',
+                'data': data
+            }
+        ), 200
+
+
+@api.route('/alltables/', methods=['GET', 'POST'])
+def all_tables():
+    """
+    查询所有已有表
+    :return:
+    """
+    data = db().show_tables
+    return jsonify(
+        {
+            'code': 200,
+            'msg': 'Success',
+            'data': data
+        }
+    ), 200
+
+
+@api.route('/export/', methods=['GET', 'POST'])
+@auth.login_required
+def export():
+    """
+    导出数据库文件
+    :return:
+    """
+    return send_file('./db/data.sqlite', as_attachment=True), 200
+
+
+@api.route('/system/', methods=['GET', 'POST'])
+@auth.login_required
+def system_info():
+    """
+    获取当前部署服务器的系统状态信息
+    :return:
+    """
+    _platform = platform.system()
+    _cpu_count = psutil.cpu_count()
+    _memory_size = psutil.virtual_memory()
+    _total_memory_size = round(_memory_size[0] / 1024 / 1024 / 1024, 2)
+    _free_memory_size = round(_memory_size[4] / 1024 / 1024 / 1024, 2)
+    _used_memory_size = round(_memory_size[3] / 1024 / 1024 / 1024, 2)
+    _percent = _memory_size[2]
+    _py_version = sys.version
+
+    return jsonify(
+        {
+            'code': 200,
+            'msg': 'Success',
+            'data': {
+                'Platform': _platform,
+                'CPU-Count': _cpu_count,
+                'Memory-Size(GigaBytes)': {
+                    'Total': _total_memory_size,
+                    'used': _used_memory_size,
+                    'Free': _free_memory_size,
+                    'Percent': _percent
+                },
+                'Python': _py_version
+            }
+        }
+    ), 200
@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/4/5
+# @File Name: config.py
+
+
+import os
+import logging
+import platform
+from logging.handlers import *
+
+
+class Config:
+    JSON_SORT_KEYS = False
+    JSON_AS_ASCII = False
+    SSL_REDIRECT = False
+    SECRET_KEY = ''
+
+    @staticmethod
+    def init_app(app):
+        if not os.path.exists('./app/logs'):
+            os.mkdir('./app/logs')
+
+        formatter = logging.Formatter(
+            fmt='[%(asctime)s] |%(filename)s[%(funcName)s:%(lineno)d] |%(levelname)-8s |%(message)s',
+            datefmt='%H:%M:%S')
+        handler = logging.handlers.RotatingFileHandler(filename='./app/logs/access.log',
+                                                       maxBytes=10240,
+                                                       backupCount=10)
+        handler.setFormatter(formatter)
+        handler.setLevel(logging.DEBUG)
+
+        if platform.system() == 'Linux':
+            syslog_handler = SysLogHandler()
+            syslog_handler.setLevel(logging.INFO)
+            app.logger.addHandler(syslog_handler)
+
+        app.logger.addHandler(handler)
+
+
+class DevelopmentConfig(Config):
+    DEBUG = True
+
+
+class ProductionConfig(Config):
+    DEBUG = False
+
+
+class HerokuConfig(ProductionConfig):
+    SSL_REDIRECT = True
+
+
+class ProfessionalConfig(ProductionConfig):
+    SSL_REDIRECT = True
+
+
+class VersionConfig:
+    # 暂未开放/Not available
+    version = ['v0.2.4']
+
+
+config = {
+    'development': DevelopmentConfig,
+    'production': ProductionConfig,
+    'professional': ProfessionalConfig,
+    'heroku': HerokuConfig,
+
+    'default': DevelopmentConfig
+}
@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: __init__.py.py
+
+
+import os
+import sys
+import requests
+
+
+def download():
+    res = requests.get('https://filebase.vercel.app/download/data.sqlite')
+    with open('./app/db/data.sqlite', 'wb') as fp:
+        fp.write(res.content)
+
+
+if not os.path.exists('./app/db/data.sqlite'):
+    try:
+        download()
+    except requests.exceptions as error:
+        sys.exit(1)
+
+__all__ = [
+    'db'
+]
@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: db.py
+
+
+import sqlite3
+from typing import List, Any
+
+
+class SQLite:
+    """操作SQLite数据库"""
+
+    def __init__(self) -> None:
+        """
+        初始化SQLite对象
+        完成后会自动提交, 自动关闭
+        """
+        self.__path = './app/db/data.sqlite'
+        self.__conn = sqlite3.connect(self.__path)
+        self.__cursor = self.__conn.cursor()
+
+    def __del__(self) -> None:
+        """
+        自动提交
+        自动关闭连接
+        :return:
+        """
+        self.__conn.commit()
+        self.__cursor.close()
+        self.__conn.close()
+
+    @property
+    def show_tables(self) -> list:
+        """
+        列出所有在数据库内的表
+        :return:
+        """
+        self.__cursor.execute('select * from sqlite_master where type="table"')
+        tables = self.__cursor.fetchall()
+        lst = []
+        for table in tables:
+            if table[1] != 'reqcount':
+                lst.append(table[1])
+        del tables
+        return lst
+
+    def exists_name(self, name: str) -> bool:
+        """
+        判断当前名称是否在数据库内
+        调用self.fetch()方法
+        :param name:
+        :return:
+        """
+        status = self.fetch(name, True)
+        if not bool(status):
+            return False
+        else:
+            return True
+
+    def exists_table(self, table: str) -> bool:
+        """
+        判断表是否在数据库内
+        调用self.fetching_table()方法
+        :param table:
+        :return:
+        """
+        tables = self.show_tables
+        if table in tables:
+            return True
+        else:
+            return False
+
+    def insert(self, name: str, times: int = 0) -> bool:
+        """
+        插入数据
+        :param name:
+        :param times:
+        :return:
+        """
+        self.__cursor.execute(
+            'insert into reqcount (name, times) values("%(name)s", %(times)s)' % {'name': name, 'times': times})
+        return True
+
+    def delete(self, name: str) -> bool:
+        """
+        删除数据
+        暂时不会用到此接口
+        :param name:
+        :return:
+        """
+        self.__cursor.execute('delete from reqcount where name="%(name)s"' % {'name': name})
+        return True
+
+    def fetch(self, name: str, is_check: bool = False) -> tuple:
+        """
+        抓取数据
+        :param name:
+        :param is_check:
+        :return:
+        """
+        self.__cursor.execute('select * from reqcount where name="%(name)s"' % {'name': name})
+        data = self.__cursor.fetchone()
+        if not is_check:
+            self.update(name, data[-1])
+        self.__cursor.execute('select * from reqcount where name="%(name)s"' % {'name': name})
+        data = self.__cursor.fetchone()
+        return data
+
+    def update(self, name: str, times: int) -> bool:
+        """
+        更新数据
+        :param name:
+        :param times:
+        :return:
+        """
+        self.__cursor.execute(
+            'update reqcount set times=%(times)s where name="%(name)s"' % {'times': times + 1, 'name': name})
+        return True
+
+    def fetching_table(self, table: str) -> List[dict]:
+        """
+        抓取主题表的数据
+        :param table:
+        :return:
+        """
+        status = self.exists_table(table)
+        if status:
+            tables = self.__cursor.execute('select * from %(table)s' % {'table': table})
+            lst = []
+            for data in tables:
+                lst.append({'index': data[0],
+                            'url': data[1],
+                            'width': data[2],
+                            'height': data[3]})
+            del tables
+            return lst
+        else:
+            return []
+
+    def exec(self, cmd: str) -> List[Any]:
+        """
+        执行特殊sql语句
+        :param cmd:
+        :return:
+        """
+        self.__cursor.execute(cmd)
+        result = self.__cursor.fetchall()
+        return result
@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: __init__.py.py
+
+
+from flask import Blueprint
+
+main = Blueprint('main', __name__)
+
+from . import views, errors
+
+__all__ = [
+    'main',
+    'views',
+    'errors'
+]
@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: errors.py
+
+from . import main
+from flask import jsonify
+
+
+@main.app_errorhandler(404)
+def page_not_found(e):
+    return jsonify(
+        {
+            'code': 404,
+            'msg': '页面未找到',
+            'data': None
+        }
+    ), 404
+
+
+@main.app_errorhandler(500)
+def internal_server_error(e):
+    return jsonify(
+        {
+            'code': 500,
+            'msg': '服务器内部错误',
+            'data': None
+        }
+    ), 500
@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: views.py
+
+
+from flask import abort
+from flask import request
+from flask import make_response
+from flask import render_template
+from ..db.db import SQLite as db
+from ..utils.response import index_
+from . import main
+
+
+@main.route('/', methods=['GET', 'POST'])
+def index():
+    """
+    主页
+    :return:
+    """
+    return render_template('index.html', remote_address=request.remote_addr)
+
+
+@main.route('/count/<string:name>', methods=['GET', 'POST'])
+def home(name: str):
+    """
+    主视图
+    :param name:
+    :return:
+    """
+    length = request.args.get('length', 7, type=int)
+    theme = request.args.get('theme', 'lewd', type=str)
+    if not db().exists_name(name):
+        db().insert(name)
+    if not db().exists_table(theme):
+        abort(500)
+    if 7 <= length <= 10:
+        data = db().fetch(name)
+        if len(str(data[1])) >= 10:  # 计数的数据长度超过最大位数将次数设为1
+            db().update(name, 0)
+        # 使用设置的长度减去已有数据的长度, 将结果转换为string类型, 再和数据库内的数据进行拼接
+        number = '0' * (length - len(str(data[-1]))) + str(data[-1])
+        response = make_response(index_(theme, int(length), name, number))
+        response.headers['Content-Type'] = 'image/svg+xml; charset=utf-8'
+        response.headers['cache-control'] = 'max-age=0, no-cache, no-store, must-revalidate'
+        return response
+    return abort(500)
@@ -0,0 +1,15 @@
+.intro {
+    text-align: center;
+}
+
+.head {
+    text-align: center;
+}
+
+.example {
+    text-align: center;
+}
+
+a {
+    color: green;
+}
@@ -0,0 +1,10 @@
+function request_async(){
+    // 使用fetch()函数进行异步请求如果服务端响应速度极慢则不会阻塞页面
+    fetch('/api/v1/test').then(
+        response => response.text()
+    ).then(
+        text => {
+            document.getElementById('fast_test_example_text').innerText = text
+        }
+    )
+}
@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Request Counter | {{ remote_address }}</title>
+    <link href="{{ url_for('static', filename='favicon.ico') }}" rel="shortcut icon">
+    <link rel="stylesheet" href="{{ url_for('static', filename='index.css') }}">
+    <script type="text/javascript" src="{{ url_for('static', filename='request.js') }}"></script>
+</head>
+<body>
+<div class="head">
+    <h1>
+        应用名: 访问次数计数器
+    </h1>
+    <h3>
+        简介: 可以使用SVG矢量图的形式来显示页面的访问次数
+        <br>
+        或者通过API的方式获取原始计数数据
+    </h3>
+</div>
+<div class="intro">
+    <div class="current_deployment_test">
+        <i><a href="{{ url_for('main.home', name='test-example') }}">点击查看当但实例调用示例</a></i>
+    </div>
+    <div class="remote_deployment_test">
+        <i><a href="https://requestcounter.herokuapp.com/count/test-example">点击查看已部署好的调用示例</a></i>
+    </div>
+    <div class="note">
+        <i><b>注: 调用支持POST 和 GET 方法请求</b></i>
+    </div>
+    <div class="open_source_protocol">
+        <i>项目开源协议: <b>Apache-2.0</b> 即:
+            <br>
+            你可以直接使用该项目提供的功能, 无需任何授权
+            <br>
+            你可以在注明来源版权信息的情况下对源代码进行任意分发和修改以及衍生
+        </i>
+    </div>
+    <div class="documents">
+        <div class="vercel">
+            <i><a href="https://request-counter-docs.vercel.app/#/" target="_blank">点击查看托管在<i>Vercel</i>上的文档</a></i>
+        </div>
+        <div class="github">
+            <i><a href="https://markusjoe.github.io/RequestCounter/" target="_blank">点击查看托管在<i>GitHub</i>上的文档</a></i>
+        </div>
+    </div>
+    <div class="ip_address">
+        <i><b>请求地址来源: {{ remote_address }}</b></i>
+    </div>
+</div>
+<div class="example">
+    <div class="svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/6" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/1" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/5" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/9" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/0" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/3" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/7" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/8" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/2" alt="fast_test_example_svg">
+        <img src="https://static-file-hosting.vercel.app/static/lewd/4" alt="fast_test_example_svg">
+    </div>
+    <div class="api">
+        <button onclick="request_async()">点击获取计数数值</button>
+        <div class="result">
+            <i><b>test-example</b>当前计数数据值: </i>
+            <p id="fast_test_example_text"></p>
+        </div>
+    </div>
+</div>
+</body>
+</html>
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="{{ general_width }}" height="{{ general_height }}" version="1.1" xmlns="http://www.w3.org/2000/svg"
+     xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>{{ title }} | {{ address }}</title>
+    <g>
+        {% for value in context %}
+            <image x="{{ value.position }}" y="0" width="{{ value.width }}" height="{{ value.height }}"
+                   xlink:href="{{ value.url }}"></image>
+        {% endfor %}
+    </g>
+</svg>
@@ -0,0 +1,7 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/26
+# @File Name: __init__.py.py
+
@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/5/1
+# @File Name: test_api.py
+
+
+import random
+import unittest
+import requests
+
+
+class TestAPI(unittest.TestCase):
+    def setUp(self) -> None:
+        self.api = 'http://127.0.0.1:5000/api/v1/'
+
+    def test_query(self):
+        res = requests.post(self.api + 'query', params={'name': 'test-example'})
+        self.assertEqual(res.status_code, 200)
+
+    def test_query_failed(self):
+        letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+        r_name = ''.join(random.choice(letters) for _ in range(10))
+        res = requests.post(self.api + 'query', params={'name': r_name})
+        self.assertEqual(res.status_code, 404)
+
+    def test_overall(self):
+        res = requests.post(self.api + 'overall')
+        self.assertEqual(res.status_code, 200)
+
+    def test_alltables(self):
+        res = requests.post(self.api + 'alltables')
+        self.assertEqual(res.status_code, 200)
+
+    def test_test(self):
+        res = int(requests.post(self.api + 'test').text)
+        self.assertIs(type(res), int)
@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/5/2
+# @File Name: test_auth.py
+
+
+import random
+import requests
+import unittest
+
+
+class TestAuth(unittest.TestCase):
+    def setUp(self) -> None:
+        self.api = 'http://127.0.0.1:5000/api/v1/'
+
+    @property
+    def r_pwd(self):
+        letters = 'abcdefghijklmnopqrstuvwxyz'
+        r_pwd = ''.join(random.choice(letters) for _ in range(16))
+        return r_pwd
+
+    def test_api_system_header(self):
+        res = requests.post(self.api + 'system', headers={'Authorization': 'bearer unittest'})
+        self.assertEqual(res.status_code, 200)
+
+    def test_api_system_query(self):
+        res = requests.post(self.api + 'system', params={'key': 'unittest'})
+        self.assertEqual(res.status_code, 200)
+
+    def test_api_system_header_failed(self):
+        res = requests.post(self.api + 'system', headers={'Authorization': f'bearer {self.r_pwd}'})
+        self.assertEqual(res.status_code, 403)
+
+    def test_api_system_query_failed(self):
+        res = requests.post(self.api + 'system', params={'key': self.r_pwd})
+        self.assertEqual(res.status_code, 403)
@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/5/1
+# @File Name: test_count.py
+
+
+import requests
+import unittest
+
+
+class TestCount(unittest.TestCase):
+    def setUp(self) -> None:
+        self.api = 'http://127.0.0.1:5000/'
+
+    def test_index(self):
+        res = requests.post(self.api).text
+        self.assertIsNotNone(res)
+
+    def test_count(self):
+        res = requests.post(self.api + 'count/test-example').text
+        self.assertIsNotNone(res)
@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/5/1
+# @File Name: test_resources.py
+
+
+import requests
+import unittest
+
+
+class TestResources(unittest.TestCase):
+    def setUp(self) -> None:
+        self.resources_urls = {
+            'docs': [
+                'https://request-counter-docs.vercel.app/#/',
+                'https://markusjoe.github.io/RequestCounter/#/'
+            ],
+            'database': 'https://filebase.vercel.app/download/data.sqlite',
+            'themes':
+                {
+                    'lewd': 'https://static-file-hosting.vercel.app/static/lewd/0',
+                    'gelbooru': 'https://static-file-hosting.vercel.app/static/gelbooru/0',
+                    'moebooru': 'https://static-file-hosting.vercel.app/static/moebooru/0',
+                    'blacked': 'https://static-file-hosting.vercel.app/static/blacked/0',
+                    'lisu': 'https://static-file-hosting.vercel.app/static/lisu/0'
+                }
+        }
+
+    def test_doc_vercel(self):
+        res = requests.post(self.resources_urls['docs'][0]).text
+        self.assertIsNotNone(res)
+
+    def test_doc_github(self):
+        res = requests.post(self.resources_urls['docs'][1]).text
+        self.assertIsNotNone(res)
+
+    def test_database(self):
+        res = requests.post(self.resources_urls['database'])
+        self.assertEqual(res.status_code, 200)
+
+    def test_themes(self):
+        for t in self.resources_urls['themes']:
+            res = requests.get(self.resources_urls['themes'][t])
+            self.assertEqual(res.status_code, 200)
@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/5/2
+# @File Name: test_view.py
+
+
+import random
+import requests
+import unittest
+
+
+class TestViews(unittest.TestCase):
+    def setUp(self) -> None:
+        self.api = 'http://127.0.0.1:5000/'
+
+    @property
+    def r_name(self):
+        letters = 'abcdefghijklmnopqrstuvwxyz'
+        r_name = [random.choice(letters) for _ in range(10)]
+        return r_name
+
+    def test_not_found(self):
+        res = requests.get(self.api + 'not_exist_page')
+        self.assertEqual(res.status_code, 404)
+
+    def test_server_internal_error(self):
+        res = requests.get(self.api + f'count/{self.r_name}', params={'length': 0})
+        self.assertEqual(res.status_code, 500)
@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: __init__.py.py
+
+__all__ = [
+    'response',
+    'password'
+]
@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/4/11
+# @File Name: password.py
+
+import random
+
+
+def generate_pwd(length):
+    """
+    生成随机密码
+    :param length:
+    :return:
+    """
+    letters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+    return ''.join(random.choice(letters) for _ in range(length))
@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: response.py
+
+
+from ..db.db import SQLite as db
+from flask import request
+from flask import render_template
+from typing import Tuple
+
+
+def index_(theme: str, length: int, name: str, count: str) -> str or Tuple[bool, str]:
+    """
+    渲染模板
+    :param theme:
+    :param length:
+    :param name:
+    :param count:
+    :return:
+    """
+    datas = db().fetching_table(theme)
+    context = []
+    for i in count:
+        if i == '0':
+            context.append({'url': datas[0]['url'],
+                            'width': datas[0]['width'],
+                            'height': datas[0]['height']})
+        elif i == '1':
+            context.append({'url': datas[1]['url'],
+                            'width': datas[1]['width'],
+                            'height': datas[1]['height']})
+        elif i == '2':
+            context.append({'url': datas[2]['url'],
+                            'width': datas[2]['width'],
+                            'height': datas[2]['height']})
+        elif i == '3':
+            context.append({'url': datas[3]['url'],
+                            'width': datas[3]['width'],
+                            'height': datas[3]['height']})
+        elif i == '4':
+            context.append({'url': datas[4]['url'],
+                            'width': datas[4]['width'],
+                            'height': datas[4]['height']})
+        elif i == '5':
+            context.append({'url': datas[5]['url'],
+                            'width': datas[5]['width'],
+                            'height': datas[5]['height']})
+        elif i == '6':
+            context.append({'url': datas[6]['url'],
+                            'width': datas[6]['width'],
+                            'height': datas[6]['height']})
+        elif i == '7':
+            context.append({'url': datas[7]['url'],
+                            'width': datas[7]['width'],
+                            'height': datas[7]['height']})
+        elif i == '8':
+            context.append({'url': datas[8]['url'],
+                            'width': datas[8]['width'],
+                            'height': datas[8]['height']})
+        elif i == '9':
+            context.append({'url': datas[9]['url'],
+                            'width': datas[9]['width'],
+                            'height': datas[9]['height']})
+
+    for p, i in zip(context, range(0, length)):
+        p['position'] = i * p['width']  # 设置每张图片对应的位置
+
+    general_width = datas[0]['width'] * length  # 计算出图片总长度
+    general_height = datas[0]['height']  # 总宽度
+
+    return render_template('view.html',
+                           context=context,
+                           title=name,
+                           address=request.remote_addr,
+                           general_height=general_height,
+                           general_width=general_width)
@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: Pycharm
+# @Create Time: 2022/4/29
+# @File Name: update.py
+
+
+import os
+import base64
+import logging
+import requests
+from ..config import VersionConfig
+from typing import Dict, List
+
+
+class SelfUpdateVersion:
+    """更新本体 -> 更新单个文件"""
+
+    def __init__(self, logger: logging.Logger):
+        self.api = 'https://api.github.com/repos/MarkusJoe/RequestCounter/tags'
+        self.headers = {'Authorization': 'token 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'}
+        self.resp = requests.get(self.api, headers=self.headers).json()
+        self.logger = logger
+
+    def commit_details(self):
+        """
+        获取提交细节
+        :return:
+        """
+        commit_url = self.resp[0]['commit']['url']
+        res = requests.get(commit_url, headers=self.headers).json()
+        files = res['files']
+        modified = []
+        deleted = []
+
+        for f in files:
+            file_path = f['filename']
+            base64_content = requests.get(f['contents_url'], headers=self.headers).json()['content']  # 直接获取修改文件的base64
+            if f['status'] in ['modified', 'added']:
+                modified.append({'filename': f'./{file_path}', 'content': base64.b64decode(base64_content)})
+            else:
+                deleted.append(f'./{file_path}')
+
+        self.apply_change(modified, deleted)
+
+    def apply_change(self, modified: List[Dict], deleted: List):
+        """
+        应用已经更改的文件
+        :param modified:
+        :param deleted:
+        :return:
+        """
+        for d in deleted:
+            os.remove(d)
+            self.logger.info(f'删除了: {d}')
+
+        for m in modified:
+            with open(m['filename'], 'wb') as modify:
+                modify.write(m['content'])
+                self.logger.info(f'修改了: {m["filename"]}')
+
+        with open('./app/config.py', 'wb') as update_config:
+            content = requests.get('https://api.github.com/repos/MarkusJoe/RequestCounter/contents/app/config.py',
+                                   headers=self.headers).json()['content']
+            update_config.write(base64.b64decode(content))
+
+        exit()
+
+    def check(self):
+        current = VersionConfig.version[0]
+        newest = self.resp[0]['name']
+        if current != newest:
+            self.logger.warning(f'当前版本已经落后于最新版本. 当前: {current} -> 远程: {newest}')
+            self.commit_details()
+            return False
+        else:
+            self.logger.info('当前版本为最新版本')
+            return True
@@ -0,0 +1,259 @@
+# 这里是Request Counter的文档
+
+> 虽然说项目很小根本不需要文档
+
+# 工作原理
+
+> Flask 建立服务器来接收请求并返回对应的响应体
+
+# 部署
+
+> 在部署之前你需要先安装`python3.10.x`以上的版本
+
+## 部署到本地服务器
+
+ ```shell
+ $ git clone https://github.com/MarkusJoe/RequestCounter.git
+ $ cd RequestCounter
+ $ pip3 install -r requirements.txt
+ $ python3 manage.py 
+ ```
+
+# 普通接口
+
+## `/count/` 接口
+
+> 必选参数: `name`: `str` 可选参数: `length`: `int` ; `theme`: `str`
+
+### 调用示例
+
+```shell
+$ curl -L -X https://requestcounter.herokuapp.com/count/test-example/
+```
+
+```json
+"..."
+```
+
+# API
+
+* 注意事项
+
+1. `/api/v1/`内的接口需要`key`来访问的有: `/export/` 可以将`key`放入请求头使用也可以作为查询参数使用
+2. `key`从环境变量中获取或者从`config.py`内的`Production`类的`SECRET_KEY`获取, 先判断环境变量是否存在如果不存在就使用`config.py`, 如果两个都存在则使用环境变量
+3. `key`的长度为`16`位的随机英文字母大小写字符串
+4. 目前需要`key`的接口有`export` `system`
+
+> 地址前缀: `/api/v1/`
+
+- 接口地址: `/overall/`, `/query/`, `/theme/`
+- 请求方法: `GET` `POST`
+
+## 单元测试
+
+> 通用
+
+```shell
+$ python3 -m unittest app/tests/test_*
+```
+
+> `Unix (Linux, Mac, etc.)`
+
+```shell
+$ export FLASK_APP=manage.py
+$ flask test
+```
+
+> `Windows CMD`
+
+```shell
+set FLASK_APP=manage.py
+flask test
+```
+
+> `Windows PowerShell`
+
+```shell
+env:FLASK_APP=manage.py
+flask test
+```
+
+## `key 使用示例`
+
+> `key`的获取优先使用请求头内的数据
+
+```python
+import requests
+
+
+def login_with_header():
+    # 使用请求头登陆
+    header = {'Authorization': 'bearer unittest'}
+    resp = requests.get('http://127.0.0.1:5000/api/v1/system/', headers=header)
+    print(resp.json())
+
+
+def login_with_query():
+    # 使用查询参数登陆
+    resp = requests.get('http://127.0.0.1:5000/api/v1/system/', params={'key': 'unittest'})
+    print(resp.json())
+
+
+if __name__ == '__main__':
+    login_with_header()
+    login_with_query()
+
+```
+
+## `/overall/` 接口
+
+> 使用此接口获取数据库中所有的数据
+
+> 必选参数: `limit: int` > 自定义查询数量, 输入的数字大于等于最大值时, 将返回最大值
+
+### 调用示例
+
+```shell
+$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/overall/?limit=20
+```
+
+```json
+{
+  "code": 200,
+  "msg": "Success. Total: 7 row(s)",
+  "data": [
+    {
+      "name": "sda",
+      "times": 72
+    },
+    {
+      "name": "main",
+      "times": 59
+    }
+  ]
+}
+```
+
+## `/query/` 接口
+
+> 使用此接口获取数据库中指定的数据
+
+***使用此接口查询的名称计数数值会加一***
+
+> 必选参数: `name: str`  > 查询指定名称的计数数据
+
+> 可选参数: `nochange: Any`
+
+> `nochange`: 'Any` > 将参数值设置为任意值则仅查询不增加
+
+### 调用示例
+
+```shell
+$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/query/?name=main&nochange=1
+```
+
+```json
+{
+  "code": 200,
+  "msg": "Success",
+  "data": [
+    "main",
+    59
+  ]
+}
+```
+
+## `/theme/` 接口
+
+> 使用此接口获取数据库内原始的base64编码的主题图片
+
+> 必选参数: `theme: str`
+
+### 调用示例
+
+```shell
+$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/theme/?name=lewd
+```
+
+```json
+
+{
+  "code": 200,
+  "msg": "Success",
+  "data": [
+    {
+      "index": "...",
+      "url": "...",
+      "width": 45,
+      "height": 100
+    },
+    "..."
+  ]
+}
+```
+
+## `/alltables/` 接口
+
+> 此接口可以获取数据库内所有的表名  > 返回的数据中不包含`ReqCount`
+
+> 无参数
+
+```shell
+$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/alltables/
+```
+
+```json
+{
+  "code": 200,
+  "msg": "Success",
+  "data": [
+    "..."
+  ]
+}
+```
+
+## `/export/` 接口
+
+> 此接口可以导出应用的数据库文件
+
+> 无参数
+
+### 调用示例
+
+```shell
+$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/export/
+```
+
+> 该接口请求成功后返回文件
+
+## `/test/`接口
+
+> 此接口仅用于测试 只能增加`test-example`名称的计数次数
+
+> 无需`key`即可请求
+
+### 调用示例
+
+```shell
+$ curl -L -X GET https://requestcounter.herokuapp.com/api/v1/test/
+```
+
+```json
+622
+```
+
+> 返回一个`int`数字
+
+# 关于
+
+## 开源
+
+- 本项目以Apache-2.0许可开源, 即:
+    - 你可以直接使用该项目提供的功能, 无需任何授权
+    - 你可以在**注明来源版权信息**的情况下对源代码进行任意分发和修改以及衍生
+
+## 关于此页面
+
+此文档由 [docsify](https://github.com/docsifyjs/docsify) 生成. docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html
+文件，所有转换工作都是在运行时进行。
+ 
@@ -0,0 +1,13 @@
+![logo](./icon.svg)
+
+# RequestCounter
+
+> Python版的计数器
+
+> 使用Python Flask 库完成的访问的次数计数器
+
+* 响应速度快
+* 使用Sqlite3数据库操作
+
+[GitHub](https://github.com/MarkusJoe/RequestCounter.git)
+[Get Started](#部署)
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>RequestCounter 帮助文档</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'RequestCounter',
+      repo: 'https://github.com/MarkusJoe/RequestCounter',
+      coverpage: true
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>
@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2022/3/25
+# @File Name: manage.py
+
+
+import os
+import unittest
+from app import create_app
+
+dyno = os.getenv('DYNO')
+if dyno is not None:
+    config = 'heroku'
+else:
+    config = os.getenv('FLASK_CONFIG') or 'default'
+
+app = create_app(config)
+
+
+@app.cli.command('test')
+def tests_cli():
+    all_test = unittest.TestLoader().discover('app/tests/')
+    unittest.TextTestRunner(verbosity=2).run(all_test)
+
+
+if __name__ == '__main__':
+    from gevent import pywsgi
+
+    app.logger.info('服务运行在 http://127.0.0.1:5000')
+    try:
+        server = pywsgi.WSGIServer(('0.0.0.0', 5000), app)
+        server.serve_forever()
+    except KeyboardInterrupt:
+        app.logger.info('已退出')
+    except OSError:
+        app.logger.critical('5000 端口已被占用')
+        exit(1)
@@ -0,0 +1,10 @@
+flask~=2.1.1
+requests~=2.26.0
+gunicorn~=20.1.0
+Werkzeug~=2.0.3
+itsdangerous~=2.1.0
+flask_sslify~=0.1.5
+gevent~=21.12.0
+psutil~=5.9.0
+click~=8.1.2
+flask_httpauth~=4.6.0