Skip to content

Commit

Permalink
chore: prepare skeleton for app
Browse files Browse the repository at this point in the history
  • Loading branch information
bednar committed May 3, 2023
1 parent b139cda commit 6f8b067
Show file tree
Hide file tree
Showing 13 changed files with 330 additions and 2 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Bug Report
description: Create a bug report to help us improve
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking time to fill out this bug report! We reserve this repository issues for bugs with reproducible problems.
Please redirect any questions about the client usage to our [Community Slack](https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA) or [Community Page](https://community.influxdata.com/) we have a lot of talented community members there who could help answer your question more quickly.
* Please add a :+1: or comment on a similar existing bug report instead of opening a new one.
* Please check whether the bug can be reproduced with the latest release.
- type: textarea
id: specifications
attributes:
label: Specifications
description: Describe the steps to reproduce the bug.
value: |
* Client Version:
* InfluxDB Version:
* Platform:
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Code sample to reproduce problem
description: Provide a code sample that reproduces the problem
value: |
```csharp
```
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Describe what you expected to happen when you performed the above steps.
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: Describe what actually happened when you performed the above steps.
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional info
description: Include gist of relevant config, logs, etc.
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Create a feature request to make client more awesome
labels: ["feature request"]
body:
- type: markdown
attributes:
value: |
Thanks for taking time to share with us this feature request! Please describe why you would like this feature to be added to the client, how you plan to use it to make your life better.
- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe how you plan to use this feature.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Describe what you expected to happen when you performed the above steps.
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: Describe what actually happened when you performed the above steps.
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional info
description: Include gist of relevant config, logs, etc.
validations:
required: false

17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Support request
description: Open a support request
labels: ["support"]
body:
- type: markdown
attributes:
value: |
WOAHH, hold up. This isn't the best place for support questions.
You can get a faster response on slack or forums:
Please redirect any QUESTIONS about Telegraf usage to
- InfluxData Slack Channel: https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA
- InfluxData Community Site: https://community.influxdata.com
- type: textarea
attributes:
label: "Please direct all support questions to slack or the forums. Thank you."
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Closes #

## Proposed Changes

_Briefly describe your proposed changes:_

## Checklist

<!-- Checkboxes below this note can be erased if not applicable to your Pull Request. -->

- [ ] CHANGELOG.md updated
- [ ] Rebased/mergeable
- [ ] A test has been added if appropriate
- [ ] Tests pass
- [ ] Commit messages are [conventional](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] Sign [CLA](https://www.influxdata.com/legal/cla/) (if not already signed)
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "nuget"
directory: "/"
schedule:
interval: "daily"
31 changes: 31 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: "CodeQL"

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
CodeQL-Build:
runs-on: ubuntu-latest

permissions:
security-events: write
actions: read
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: csharp

- name: Autobuild
uses: github/codeql-action/autobuild@v2

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
34 changes: 34 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: "Lint Code Base"

on:
push:
branches-ignore: [main]
pull_request:
branches: [main]

jobs:
build:
permissions:
contents: read
packages: read
statuses: write

name: Lint Code Base
runs-on: ubuntu-latest

steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Lint Code Base
uses: github/super-linter@v4.9.2
env:
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
LINTER_RULES_PATH: '.'
MARKDOWN_CONFIG_FILE: .markdownlint.yml
VALIDATE_MARKDOWN: true
VALIDATE_BASH: true
14 changes: 14 additions & 0 deletions .github/workflows/semantic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: "Semantic PR and Commit Messages"

on:
pull_request:
types: [opened, reopened, synchronize, edited]
branches:
- main

jobs:
semantic:
uses: influxdata/validate-semantic-github-messages/.github/workflows/semantic.yml@main
with:
CHECK_PR_TITLE_OR_ONE_COMMIT: true
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/.idea/

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
coverage.*
7 changes: 7 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"MD013": false,
"MD033": {
"allowed_elements": [ "a", "img", "p" ]
},
"MD041": false,
}
18 changes: 18 additions & 0 deletions InfluxDB3.Client.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<Content Include=".github\dependabot.yml" />
<Content Include=".github\ISSUE_TEMPLATE\BUG_REPORT.yml" />
<Content Include=".github\ISSUE_TEMPLATE\FEATURE_REQUEST.yml" />
<Content Include=".github\ISSUE_TEMPLATE\SUPPORT.yml" />
<Content Include=".github\PULL_REQUEST_TEMPLATE.md" />
<Content Include=".github\workflows\codeql-analysis.yml" />
<Content Include=".github\workflows\linter.yml" />
<Content Include=".github\workflows\semantic.yml" />
</ItemGroup>

</Project>
9 changes: 9 additions & 0 deletions InfluxDBClient.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
using System;

namespace InfluxDB3.Client
{
public class InfluxDBClient
{

}
}
75 changes: 73 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,73 @@
# -influxdb3-csharp
The C# .NET Driver that provides a simple and convenient way to interact with InfluxDB 3.
<p align="center">
<span style="color: rgb(81, 43, 212); font-family: monospace; font-weight: 700; font-size: 3.25rem">.NET Standard</span>
</p>
<p align="center">
<a href="https://www.nuget.org/packages/InfluxDB3.Client">
<img src="https://buildstats.info/nuget/InfluxDB3.Client" alt="NuGet Badge">
</a>
<a href="https://github.com/bonitoo-io/influxdb3-csharp/actions/workflows/codeql-analysis.yml">
<img src="https://github.com/bonitoo-io/influxdb3-csharp/actions/workflows/codeql-analysis.yml/badge.svg?branch=main" alt="CodeQL analysis">
</a>
<a href="https://github.com/bonitoo-io/influxdb3-csharp/actions/workflows/linter.yml">
<img src="https://github.com/bonitoo-io/influxdb3-csharp/actions/workflows/linter.yml/badge.svg" alt="Lint Code Base">
</a>
<a href="https://dl.circleci.com/status-badge/redirect/gh/bonitoo-io/influxdb3-csharp/tree/main">
<img src="https://dl.circleci.com/status-badge/img/gh/bonitoo-io/influxdb3-csharp/tree/main.svg?style=svg" alt="CircleCI">
</a>
<a href="https://codecov.io/gh/bonitoo-io/influxdb3-csharp">
<img src="https://codecov.io/gh/bonitoo-io/influxdb3-csharp/branch/main/graph/badge.svg" alt="Code Cov"/>
</a>
<a href="https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA">
<img src="https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social" alt="Community Slack">
</a>
</p>

# InfluxDB 3 C# .NET Client

The C# .NET client that provides an easy and convenient way to interact with InfluxDB 3.
This package supports both writing data to InfluxDB and querying data using the FlightSQL client,
which allows you to execute SQL queries against InfluxDB IOx.

## Installation

Add the latest version of the client to your project:

```sh
dotnet add package InfluxDB3.Client
```

## Usage

To start with the client, import the `InfluxDB3.Client` package and create a `InfluxDBClient` by constructor initializer:

```csharp
// TBD
```

to insert data, you can use code like this:

```csharp
// TBD
```

to query your data, you can use code like this:

```csharp
// TBD
```

## Feedback

If you need help, please use our [Community Slack](https://app.slack.com/huddle/TH8RGQX5Z/C02UDUPLQKA)
or [Community Page](https://community.influxdata.com/).

New features and bugs can be reported on GitHub: <https://github.com/bonitoo-io/influxdb3-csharp>

## Contribution

If you would like to contribute code you can do through GitHub by forking the repository and sending a pull request into
the `main` branch.

## License

The InfluxDB 3 C# .NET Client is released under the [MIT License](https://opensource.org/licenses/MIT).

0 comments on commit 6f8b067

Please sign in to comment.