Metadata-Version: 2.4
Name: flask-pluginkit-accesscount
Version: 0.3.1
Summary: IP、PV、Endpoint Statistics
Home-page: https://github.com/saintic/flask-pluginkit-accesscount
Download-URL: https://github.com/saintic/flask-pluginkit-accesscount
Author: Hiroshi.tao
Author-email: me@tcw.im
Keywords: flask-pluginkit
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Flask-PluginKit>=3.8.0
Requires-Dist: prettytable>=3.16.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# AccessCount

IP、PV、Endpoint 统计插件

## Installation

### Development

`pip install git+https://github.com/saintic/flask-pluginkit-accesscount@master`

### PyPi Release

`pip install flask-pluginkit-accesscount`

## Usage

```python
from flask_pluginkit import PluginManager

PluginManager(
    plugin_packages=["flask_pluginkit_accesscount"],
    # If Flask-PluginKit version >= 3.10.0, otherwise pip install it.
    install_packages=dict(pkgs=["flask-pluginkit-accesscount"]),
)
```

## Configuration

Flask Config 配置项

### PLUGINKIT_ACCESSCOUNT_FLUSH_TIMES
设置本地累计请求多少次后刷入redis，int 类型，默认 100

### PLUGINKIT_ACCESSCOUNT_FLUSH_INTERVAL
设置本地累计请求多少秒后刷入redis，int 类型，默认 60

### PLUGINKIT_ACCESSCOUNT_KEY_PREFIX
redis key 前缀，str 类型，默认 pluginkit

### PLUGINKIT_ACCESSCOUNT_REDIS_NAME
redis client 实例连接名称，str 类型，默认 redis，从 g 获取

### PLUGINKIT_ACCESSCOUNT_REDIS_URL
redis 连接地址，str 类型，如果不指定上述NAME，则从该地址连接，两者不能同时缺少。
