Skip to content

Commit 852b499

Browse files
mirkosprojectsmirkosprojects
committed
update readme template
1 parent 63ebfe1 commit 852b499

File tree

1 file changed

+44
-150
lines changed

1 file changed

+44
-150
lines changed

‎README.md‎

Lines changed: 44 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<h3 align="center">Deep Feature Matching</h3>
2020

2121
<p align="center">
22-
A social media bot, capable of posting to Instagram and Whatsapp!
22+
Meshroom DFM is a Meshroom implementation of the Deep Feature Matching Algorithm from <a href="https://github.com/ufukefe/DFM">ufukefe</a>.
2323
<br />
2424
<a href="#readme-toc"><strong>Explore the docs »</strong></a>
2525
<br />
@@ -36,15 +36,12 @@
3636

3737

3838
<!-- TABLE OF CONTENTS -->
39-
<a name="readme-toc"></a>
39+
<!-- <a name="readme-toc"></a>
4040
<details>
4141
<summary>Table of Contents</summary>
4242
<ol>
4343
<li>
4444
<a href="#about-the-project">About The Project</a>
45-
<!-- <ul>
46-
<li><a href="#built-with">Built With</a></li>
47-
</ul> -->
4845
</li>
4946
<li>
5047
<a href="#getting-started">Getting Started</a>
@@ -74,17 +71,17 @@
7471
<li><a href="#license">License</a></li>
7572
<li><a href="#acknowledgments">Acknowledgments</a></li>
7673
</ol>
77-
</details>
74+
</details> -->
7875

7976

8077
<!-- ABOUT THE PROJECT -->
8178
## About The Project
8279

8380
![Product Name Screen Shot][product-screenshot]
8481

85-
The HKA Social Media Bot is a tool capable of posting images and messages to various social media websites. ~~Keep your workflow steady with scheduled posts and automatic image generation!~~
86-
87-
<!-- The HKA Social Media Bot is a command line tool, capable of sending or posting various messages to social media websites. Keep your workflow steady with scheduled posts and automatic image generation! -->
82+
MeshroomDFM is a Meshroom Node that employs a Convolutional Neural Network to generate and refine feature matches between multiple images.
83+
The goal of this project is to replace the classical Photogrammetry Pipeline Nodes for Feature Extraction, Image Matching and Feature Matching with an all-in-one solution.
84+
Since Developer Documentation for creating custom Meshroom Nodes is hard to come by, the documentation for this project also demonstrates how to build and deploy binaries build with python and pyinstaller.
8885

8986
<p align="right">(<a href="#readme-top">back to top</a>)</p>
9087

@@ -105,174 +102,71 @@ The HKA Social Media Bot is a tool capable of posting images and messages to var
105102
<!-- GETTING STARTED -->
106103
## Getting Started
107104

108-
### Installation
109-
* Creating a new virtual environment
105+
You can simply install the precompiled binaries for linux in the <a href="#installation">Installation</a> step.
106+
If you wish to build the binaries yourself, follow <a href="#building-from-source">Building from Source</a>
110107

111-
This app is built on [Flask][flask], which recommends creating a new conda environment
112-
```sh
113-
conda create -n socialmediabotEnv python=3.9.7 anaconda
114-
conda activate socialmediabotEnv
115-
```
108+
### Installation
116109

117-
> **Note**
118-
> If you have closed your terminal window, you can reactivate your virtual environment by typing ```conda activate socialmediabotEnv``` again
110+
* download the precompiled binaries for Linux
119111

120-
* Clone the repo
121-
```sh
122-
git clone https://github.com/mirkosprojects/socialmedia-bot.git
123-
```
124-
* Install dependencies
125-
```sh
126-
cd socialmedia-bot
127-
pip install -r requirements.txt
128-
````
129-
For more information about the dependencies see [requirements][requirements]
112+
* copy the binaries into the Meshroom binaries directory
113+
```sh
114+
cp dist path/to/bin
115+
```
130116

131-
### Creating a Facebook Business Account
117+
* download the Mehsroom Nodes
132118

133-
```
134-
HOW TO CREATE OR CONVERT TO A FACEBOOK BUSINESS ACCOUNT
135-
```
119+
* copy the nodes into the Meshroom nodes directory
120+
```sh
121+
cp nodes path/to/nodes
122+
```
136123

137-
### Creating an Instagram Business Account
138124

139-
```
140-
HOW TO CREATE OR CONVERT TO AN INSTAGRAM BUSINESS ACCOUNT
141-
```
125+
### Building from Source
142126

143-
### Linking to Facebook
144-
```
145-
HOW TO LINK WHATSAPP AND INSTAGRAM ACCOUNTS TO FACEBOOK
146-
```
127+
To build the binaries yourself, you can use pyinstaller to export the project.
147128

148-
### Getting an Access Token
129+
> **Note**
130+
> Pyinstaller only allows to build binaries for the platform you're running on.
131+
> If you wish to build the binaries for windows, you will have to execute pyinstaller on a windows machine.
149132
150-
<!-- This program needs your authorization in order to publish to Instagram and Whatsapp. To grant access, login to your Facebook Account and search for HKA SocialMediaBot.
151-
Click add and grant access to the requested rights.
133+
* Creating a new virtual environment
152134
153-
Once you've granted the required permissions, you will receive an Access Token. Copy this Token and continue with <a href="#usage">Usage</a> -->
135+
It is recommended to create a virtual environment with the required packages
136+
```sh
137+
conda env create -f environment.yml
138+
```
154139
155-
```
156-
HOW TO ADD FACEBOOK APP TO ACCOUNT AND RECEIVE ACCESS TOKEN
157-
```
140+
* Execute pyinstaller to build binaries
141+
```sh
142+
pyinstaller dfm_wrapper.spec --onefile # build the Deep Feature Matching Program
143+
pyinstaller dfm_analyzer.spec --onefile # build Deep Feature Matching Analyzer
144+
```
158145
159-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
146+
* After building the binaries, you can continue with the installation steps 3 and 4
160147
148+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
161149
162150
<!-- USAGE EXAMPLES -->
163151
## Usage
164152
165-
### Starting the app
166-
* Starting the app
167-
```sh
168-
python main.py
169-
```
170-
Once the app has started, it will output an ip adress (usually 127.0.0.1:5000), copy and paste it in your browser
171-
172-
### Sign up
173-
You will be redirected to a Login Page, create a new user account and log in with your email and password.
174-
175-
> **Note**
176-
> The website is running locally on your machine. Email adresses and passwords are stored in a local database at ```socialmedia-bot/instance/database.db```
153+
### Implementing the DFM Node
177154
178-
### Updating credentials
179-
You will have to update your credentials.
180-
Go to ```Settings``` &rarr; ```Whatsapp```, enter your access token and phone number and click ```Update```.
181-
Repeat this step with your other social media accounts.
155+
* start Meshroom
182156
183-
### Creating a contact list
184-
Sending messages to whatsapp contacts requires their phone number.
185-
Go to ```Settings``` &rarr; ```Contacts``` and enter the contacts, you wish to message through whatsapp.
157+
* right click and type "DeepFeatureMatching" to add the Deep Feature Matching Node
186158
187-
### Creating your first post
188-
Go back to ```Home``` and type in a text, you wish to post.
189-
Add an image to the post by clicking on ```Select File``` or drag and drop it.
190-
Select the websites, you wish to post to and click on ```Post```.
191-
192-
> **Note**
193-
> You can have up to 1000 free whatsapp conversations per month, for more information about pricing, see [pricing][whatsapp-pricing]
194-
195-
> **Note**
196-
> You can post up to 25 pictures on instagram per day
197-
198-
> **Warning**
199-
> In order to post an image through the Graph-API, this program publishes the image on [imgbox.com][imgbox]. This means, your photos will be available on the internet, even after you delete them from Instagram.
159+
* The node has inputs and outputs. Connect them as follows.
200160
201161
<p align="right">(<a href="#readme-top">back to top</a>)</p>
202162
203163
204-
<!-- PROFESSIONAL USAGE / NEXT STEPS -->
205-
## Next steps
206-
207-
### Running the app on the local network
208-
You can run this application locally on your network, start it as follows
209-
```sh
210-
python main.py --host=0.0.0.0
211-
```
212-
Any other device on the network can now open the website by typing the returned ip adress.
213-
214-
> **Note**
215-
> The default port is 5000. In some cases this port might be used by different applications. You can specify a different port with the ```--port``` argument
216-
217-
> **Warning**
218-
> Multiple users shouldn't access the same account simultaneously
219-
220-
### Publishing the app to the internet
221-
Cloud hosting providers like [DigitalOcean][digital-ocean] can host websites for you, making your app available on the internet.
222-
223-
> **Warning**
224-
> Additional security measures might need to be implemented
225-
226-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
227-
228-
229-
<!-- ROADMAP -->
230-
## Roadmap
231-
232-
- [ ] Proof of Concept
233-
- [x] Whatsapp
234-
- [x] Instagram
235-
- [ ] Facebook
236-
- [ ] Twitter
237-
- [ ] Snapchat
238-
- [ ] LinkedIn
239-
- [ ] Webapp
240-
- [x] Rewrite as webapp using Flask
241-
- [x] HTML GUI
242-
- [ ] Database
243-
- [x] password access
244-
- [x] storing contacts
245-
- [ ] storing posts
246-
- [ ] Publishing to the internet
247-
- [ ] Security improvements
248-
- [ ] Deploy using Digital Ocean or other webhost
249-
- [ ] Publishing the facebook app
250-
- [ ] Image Generator using templates
251-
- [ ] Scheduling Posts
252-
253-
254-
<!-- See the [open issues](https://github.com/mirkosprojects/socialmedia-bot/issues) for a full list of proposed features (and known issues). -->
255-
256-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
257-
258164
259165
<!-- PICTURES AND VIDEOS -->
260-
## Pictures and Videos
261-
262-
### Sending a whatsapp message and posting to instagram using Socialbot
166+
<!-- ## Pictures and Videos
263167
264-
![Sending a Whatsapp message][whatsapp-instagram-demo]
265168
266-
### Changing the whatsapp access token and phone number
267-
268-
![Changing Whatsapp settings][whatsapp-settings]
269-
270-
### Editing the contacts
271-
272-
![Editing Contact][contact-settings]
273-
274-
275-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
169+
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
276170
277171
278172
<!-- LICENSE -->
@@ -297,8 +191,7 @@ Project Link: [https://github.com/mirkosprojects/socialmedia-bot](https://github
297191
## Acknowledgments
298192
299193
* [Readme Template](https://github.com/othneildrew/Best-README-Template)
300-
* [Flask Template](https://github.com/techwithtim/Flask-Web-App-Tutorial)
301-
* <a href="https://www.flaticon.com/de/kostenlose-icons/bot" title="bot Icons">Bot Icons erstellt von Smashicons - Flaticon</a>
194+
* [DFM: A Performance Baseline for Deep Feature Matching](https://github.com/ufukefe/DFM)
302195
* [iMessage Speech Bubbles](https://codepen.io/AllThingsSmitty/pen/jommGQ)
303196
304197
<p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -320,6 +213,7 @@ Project Link: [https://github.com/mirkosprojects/socialmedia-bot](https://github
320213
[license-url]: https://github.com/mirkosprojects/socialmedia-bot/blob/main/LICENSE
321214
322215
[flask]: https://flask.palletsprojects.com/en/2.2.x/
216+
[dfm]: https://github.com/ufukefe/DFM
323217
324218
<!-- RESSOURCES -->
325219
[product-screenshot]: /website/static/images/user_page1.png

0 commit comments

Comments
 (0)