Mercurial > public > bitcaviar

changeset 15:381b13eff3a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change info files
author Dennis <dennis@denniscm.com>
date Fri, 11 Aug 2023 16:12:30 +0000
parents 7b9da221aa3c
children ce176a2c722b
files .github/ISSUE_TEMPLATE/bug_report.md .github/ISSUE_TEMPLATE/feature_request.md .idea/.gitignore .idea/bitcaviar.iml .idea/inspectionProfiles/Project_Default.xml .idea/inspectionProfiles/profiles_settings.xml .idea/misc.xml .idea/modules.xml .idea/vcs.xml CHANGELOG.md DOCS.md LICENSE.md README.md
diffstat 13 files changed, 71 insertions(+), 185 deletions(-) [+]
line wrap: on
line diff
--- a/.github/ISSUE_TEMPLATE/bug_report.md	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
--- a/.github/ISSUE_TEMPLATE/feature_request.md	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
--- a/.idea/.gitignore	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,10 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Zeppelin ignored files
-/ZeppelinRemoteNotebooks/
--- a/.idea/bitcaviar.iml	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="PYTHON_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
-      <excludeFolder url="file://$MODULE_DIR$/venv" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>
\ No newline at end of file
--- a/.idea/inspectionProfiles/Project_Default.xml	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,29 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="PyArgumentEqualDefaultInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
-    <inspection_tool class="PyAugmentAssignmentInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
-    <inspection_tool class="PyBehaveInspection" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="PyClassicStyleClassInspection" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="PyCompatibilityInspection" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="ourVersions">
-        <value>
-          <list size="2">
-            <item index="0" class="java.lang.String" itemvalue="2.7" />
-            <item index="1" class="java.lang.String" itemvalue="3.10" />
-          </list>
-        </value>
-      </option>
-    </inspection_tool>
-    <inspection_tool class="PyMandatoryEncodingInspection" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="PyMissingTypeHintsInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
-    <inspection_tool class="PyUnresolvedReferencesInspection" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="ignoredIdentifiers">
-        <list>
-          <option value="src.handlers.sentiment.secrets_controller" />
-          <option value="flask.Flask" />
-        </list>
-      </option>
-    </inspection_tool>
-  </profile>
-</component>
\ No newline at end of file
--- a/.idea/inspectionProfiles/profiles_settings.xml	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="USE_PROJECT_PROFILE" value="false" />
-    <version value="1.0" />
-  </settings>
-</component>
\ No newline at end of file
--- a/.idea/misc.xml	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.8 (bitcaviar)" project-jdk-type="Python SDK" />
-</project>
\ No newline at end of file
--- a/.idea/modules.xml	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/bitcaviar.iml" filepath="$PROJECT_DIR$/.idea/bitcaviar.iml" />
-    </modules>
-  </component>
-</project>
\ No newline at end of file
--- a/.idea/vcs.xml	Wed Feb 02 16:58:13 2022 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitSharedSettings">
-    <option name="FORCE_PUSH_PROHIBITED_PATTERNS">
-      <list>
-        <option value="main" />
-      </list>
-    </option>
-  </component>
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CHANGELOG.md	Fri Aug 11 16:12:30 2023 +0000
@@ -0,0 +1,7 @@
+
+# Table of Contents
+
+
+
+-   2021-10-09 -> v0.0.1
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/DOCS.md	Fri Aug 11 16:12:30 2023 +0000
@@ -0,0 +1,55 @@
+
+# Table of Contents
+
+1.  [Installation](#orgdb921af)
+2.  [Usage](#org9fd02ba)
+    1.  [Example](#orgfc928cc)
+
+![img](https://denniscm.com/static/bitcaviar-logo.png)
+
+A simple Python wrapper for Bitcoin JSON-RPC API. If you are looking for a Bitcoin blockchain parser check my other project -> [bitcaviar-plus](https://git.sr.ht/~denniscmartin/bitcaviar-plus).
+
+
+<a id="orgdb921af"></a>
+
+# Installation
+
+    pip install bitcaviar
+
+
+<a id="org9fd02ba"></a>
+
+# Usage
+
+    from bitcaviar import config
+    
+    bitcoin = config.Bitcoin(
+        cli_dir='your/dir/to/bitcoin-cli', 
+        data_dir='/where/is/the/blockchain'
+    )
+
+
+<a id="orgfc928cc"></a>
+
+## Example
+
+Get the number of blocks in the blockchain.
+
+    from bitcaviar import config
+    from bitcaviar import blockchain
+    
+    
+    def main():
+        bitcoin = config.Bitcoin(
+    	cli_dir='bitcoin-cli', 
+    	data_dir='/Users/dennis/Bitcoin'
+        )
+    
+        block_count = blockchain.get_block_count(bitcoin=bitcoin)
+    
+        print(block_count)
+    
+    
+    if __name__ == '__main__':
+        main()
+
--- a/LICENSE.md	Wed Feb 02 16:58:13 2022 +0100
+++ b/LICENSE.md	Fri Aug 11 16:12:30 2023 +0000
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Dennis Concepción Martín
+Copyright (c) 2023 Dennis Concepción Martín
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,4 @@
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
--- a/README.md	Wed Feb 02 16:58:13 2022 +0100
+++ b/README.md	Fri Aug 11 16:12:30 2023 +0000
@@ -1,49 +1,11 @@
-<p align="center">
-  <img src="https://user-images.githubusercontent.com/66180929/136657868-0ec6971b-ed76-43f3-9689-f643e8893706.png" />
-</p>
-
-
-# bitcaviar [ARCHIVED]
-A simple Python wrapper for Bitcoin JSON-RPC API.   
-
-*If you are looking for a Bitcoin blockchain parser check [bitcaviar-plus](https://github.com/denniscm190/bitcaviar-plus).*
 
-## Installation
-```bash
-pip install bitcaviar
-```
+# bitcaviar [DEPRECATED]
 
-## Usage
-You should pass your `bitcoin-cli` directory and where you have the blockchain stored to each method.
-
-```python
-from bitcaviar import config
+A simple Python wrapper for Bitcoin JSON-RPC API
 
-bitcoin = config.Bitcoin(
-    cli_dir='your/dir/to/bitcoin-cli', 
-    data_dir='/where/is/the/blockchain'
-)
-```
-
-### Example 1
-Get the number of blocks in the blockchain
-
-```python
-from bitcaviar import config
-from bitcaviar import blockchain
-
+-   Docs: <https://denniscm.com/proj/bitcaviar.html>
+-   Main repo on SourceHut: <https://git.sr.ht/~denniscmartin/bitcaviar>
+    -   Mirrors:
+        -   Github: <https://github.com/denniscmartin/bitcaviar>
+        -   Gitlab: <https://gitlab.com/denniscmartin/bitcaviar>
 
-def main():
-    bitcoin = config.Bitcoin(
-        cli_dir='bitcoin-cli', 
-        data_dir='/Users/dennis/Bitcoin'
-    )
-    
-    block_count = blockchain.get_block_count(bitcoin=bitcoin)
-
-    print(block_count)
-
-
-if __name__ == '__main__':
-    main()
-```